Users > Roles
The following endpoint retrieves the mapping of a userRoleId
parameter and user role name.
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.
Authorizations
Query parameters
colsstring[]OptionalExample:
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.
{"value":["id","name","subsidiary","category","permissions"]}
categorystring · enumOptionalExample:
Set this parameter to organization
or team
to get user roles in an organization or in a team.
team
Possible values: Responses
200
Successful response
application/json
get
200
Successful response