Get a collection's roles

GET

/collections/:collectionId/roles

Gets information about all roles in a collection. The response returns the IDs of all users, teams, and groups with access to view or edit the collection.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

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.

AuthorizationBasic

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

Path parameters

collectionIdstringRequired

The collection's ID.

Response

Successful Response

grouplist of objects

A list of the collection's group roles.

teamlist of objects

A list of the collection's team roles.

userlist of objects

A list of the collection's user roles.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	{
2	"group": [
3	{
4	"role": "VIEWER",
5	"id": 123
6	}
7	],
8	"team": [
9	{
10	"role": "EDITOR",
11	"id": 1
12	}
13	],
14	"user": [
15	{
16	"role": "VIEWER",
17	"id": 12345678
18	},
19	{
20	"role": "EDITOR",
21	"id": 87654321
22	}
23	]
24	}