See api-docs Menu

Get Role Users

This API returns a list of users assigned to a specific role and can include users who aren’t currently assigned to the role.

Pagination is supported on this endpoint.





Resource URL

https://<api-domain>/api/2/roles/:id/users

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All, Read All.

Don’t return Mappings with the Roles API. Instead, use the User Mappings API and set a filter on role_id.

Request Parameters

name

required

string

Allows you to filter on first name, last name, username, and email address.

include_unassigned

boolean

Optional. Defaults to false. Include users that aren’t assigned to the role.

Sample Responses

{
    "id": 345,
    "name": "Joe User",
    "username": "joe.user@example.com",
    "added_by": {
      "id":678,
      "name:": "Susan Boss"
    }    
    "added_at": "2019-12-27T00:00:00Z",
    "assigned": true (Indicates if assigned to role or not. Defaults to true.)
}
}

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

The requested resource doesn’t exist.

{
    "message": "The resource with the given id could not be found",
    "statusCode": 404,
    "name": "NotFoundError"
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for Roles API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

Get Role Users

curl 'https://<api-domain>/api/2/roles/:id/users' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.