API v1 ReferenceRoles

Returns all users of the role with the specified id.

Returns all users of the role with the specified id. <Check title="Required Permissions">The user must be an admin or have `workspace-manage-config:read` permissions.</Check>

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

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
userIdstring or nullformat: "uuid"
The id of the user to add to the role.
isDeactivatedboolean or null
Whether the user is deactivated in this role.
roleIdstring or nullformat: "uuid"
The id of the role the user is assigned to.