API ReferenceWorkspaces

Get a workspace's roles

View as Markdown

Gets the roles of users, user groups, and partners in a workspace.

Note:

Partner roles don’t support SCIM IDs.

Authentication

x-api-keystring
API Key authentication via header
OR
Authorizationstring
A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
OR
AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

workspaceIdstringRequired
The workspace's ID.

Query parameters

includeenumOptional
Include the following information in the endpoint's response: - `scim` — Return IDs as SCIM user and group IDs.
Allowed values:

Response

Successful Response
roleslist of objects
A list of workspace roles and the users, groups, and partners assigned to them.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error