API v1 ReferenceRoles

Returns all permissions 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
featurestring or null
The feature these permissions belong to.
accessLevelslist of strings or null
The access levels applied to this feature.
idUUID or null
The id of the permission.
createdOndatetime or null
The date this entity was created.
updatedOndatetime or null
The date this entity was last modified.
subdomainslist of strings or null

The workspace’s subdomains. Read-only.

identityIdslist of UUIDs or null

The ids of identities assigned to this workspace. Read-only.