Users > Roles

The following endpoint retrieves the mapping of a userRoleId parameter and user role name.

User role definitions

get
/users/roles

Gets list of all existing user role names and IDs. Set the user roles in an organization with the POST /users/{userId}/user-organization-roles/{organizationId} API call. Use the POST /users/{userId}/user-team-roles/{teamId} API call to set user roles in a team.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
colsstring[]Optional

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

Example: {"value":["id","name","subsidiary","category","permissions"]}
categorystring · enumOptional

Set this parameter to organization or team to get user roles in an organization or in a team.

Example: teamPossible values:
Responses
200

Successful response

application/json
get
/users/roles
200

Successful response

Last updated