Search roles for users

Returns the roles held by up to 10 users.

POST /fieldservicegateway/usermanagement/v3/authorization/users/user-roles/search

Request

Field	Type	Required	Description
userNumbers	number[]	yes	1–10 user numbers. Duplicates are not allowed. Each number must be 1 or greater

Example

{
  "userNumbers": [1001, 1002]
}

cURL

curl --request POST 'https://[BASE_URL]/fieldservicegateway/usermanagement/v3/authorization/users/user-roles/search' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: {{x-api-key}}' \
  --header 'Authorization: {{Authorization}}' \
  --header 'Asurion-correlationid: correlation-id' \
  --header 'Asurion-enduser: end-user' \
  --header 'Asurion-sourcesystem: source-system' \
  --header 'Asurion-serviceprovider: company-id' \
  --header 'Asurion-client: default' \
  --data '{
    "userNumbers": [1001, 1002]
  }'

Response

200 OK

{
  "success": true,
  "data": {
    "users": [
      {
        "userNumber": 1001,
        "roles": [
          {
            "applicationId": "Honeycomb",
            "roleName": "Technician"
          }
        ]
      }
    ]
  }
}

A user with no roles comes back with an empty roles array.

Errors

Status	Code	When
400	VALIDATION_ERROR	The list is empty, has more than 10 users, or repeats a user number
500	INTERNAL_ERROR	Something unexpected failed