Embedded APIResourcesRoles

List custom roles

Lists all custom roles in a customer workspace.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

Headers

AuthorizationstringRequired

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

Query parameters

pageintegerOptional

Page number of the custom roles to fetch. Defaults to 1.

per_pageintegerOptional

Number of custom roles to return in a single page. Defaults to 100. Max is 100.

role_namestringOptional
Filter by role name.

Response

Success response
idinteger or null
Unique identifier of the role.
namestring or null
Name of the role.
inheritableboolean or null
Indicates whether the role is inheritable.
folder_idslist of strings or null
List of folder IDs associated with the role.
created_atdatetime or null
Timestamp when the role was created.
updated_atdatetime or null
Timestamp when the role was last updated.
privilegesobject or null

Errors