Skip to navigation
API v1 ReferenceRoles

Returns users of the specified role.

Returns users of the specified role. The result lists users assigned to the role.

Required Permissions
The user must be an admin or have workspace-manage-config:read permissions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

roleIdstringRequiredformat: "uuid"
The id of the role.

Query parameters

showArchivedbooleanOptionalDefaults to false
Whether to show archived users.
pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
userIdstringformat: "uuid"
The id of the user to add to the role.
isDeactivatedbooleanOptional
Whether the user is deactivated in this role.
roleIdstringOptionalformat: "uuid"
The id of the role the user is assigned to.

Errors

404
Not Found Error