Update user

Update an existing console user resource.

Service endpoint

/users/v2/{user_id}

Optional query string parameters

—

Example

user_id: https://protectapi.cylance.com/users/v2/a2c0ac7a-a63d-4583-b646-ae10db9c9768

Method

HTTP/1.1 PUT

Request headers
  • Accept: application/json
  • Content-Type: application/json
  • Authorization: Bearer JWT Token returned by Auth API with the user:update scope encoded

Request

JSON 
{
    "email": "testuser@email.com",
    "user_role": "00000000-0000-0000-0000-000000000001",
    "first_name": "Test",
    "last_name": "User",
    "zones": [
        {
            "id": "d27ff5c4-5c0d-4f56-a00d-a1fb297e440e",
            "role_type": "00000000-0000-0000-0000-000000000002"
        }
    ]
}

Response

Please see the Response status codes for more information.

Request JSON schema

Field Name Description

email

This is the user's email address.

first_name

This is the user's first name.

last_name

This is the user's last name.

user_role

This is the unique identifier defining the user's role in the console.

  • User: 00000000-0000-0000-0000-000000000001
  • Administrator: 00000000-0000-0000-0000-000000000002
  • Read-Only: 00000000-0000-0000-0000-000000000003

zones

These are the zones to which the user has access as an array of elements.

  • id: Unique identifier for the zone
  • role_type: User's role for this particular zone
    • None: 00000000-0000-0000-0000-000000000000
    • Zone Manager: 00000000-0000-0000-0000-000000000001
    • User: 00000000-0000-0000-0000-000000000002

Note that administrators have zone management privileges in all zones; trying to use the zones parameter to explicitly set an administrator to be a Zone Manager will result in an error. 

If you are updating a user to a Zone Manager, the zones array is required.

To update a zone manager or change a user to a zone manager, set the user_role to User and set the zones role_type to Zone Manager.

Note that if you are updating a user to a Zone Manager, the 'email' and 'user_role' parameters are mandatory.