API v1 ReferenceRoles

Returns all users of the role with the specified id.

Returns all users of the role with the specified id.

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

Path parameters

roleIdUUIDRequired

The id of the role.

Headers

AuthorizationstringRequired

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

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

userIdUUIDOptional

The id of the user to add to the role.

isDeactivatedbooleanOptional

Whether the user is deactivated in this role.

roleIdUUIDOptional

The id of the role the user is assigned to.