Get all roles

GET

/workspaces-roles

GET

/workspaces-roles

$ curl https://api.getpostman.com/workspaces-roles \
>      -H "x-api-key: <apiKey>"

1 {
2   "roles": {
3     "user": [
4       {
5         "id": "3",
6         "description": "Can manage people and all resources",
7         "displayName": "Admin"
8       },
9       {
10         "id": "2",
11         "description": "Can create and edit all resources",
12         "displayName": "Editor"
13       },
14       {
15         "id": "1",
16         "description": "Can view and collaborate on all resources",
17         "displayName": "Viewer"
18       }
19     ],
20     "usergroup": [
21       {
22         "id": "3",
23         "description": "Can manage people and all resources",
24         "displayName": "Admin"
25       },
26       {
27         "id": "2",
28         "description": "Can create and edit all resources",
29         "displayName": "Editor"
30       },
31       {
32         "id": "1",
33         "description": "Can view and collaborate on all resources",
34         "displayName": "Viewer"
35       }
36     ],
37     "partner": [
38       {
39         "id": "7",
40         "description": "Can create and edit workspace resources, and invite partners with Editor or Viewer access to the workspace",
41         "displayName": "Editor and Partner Lead"
42       },
43       {
44         "id": "6",
45         "description": "Can view, fork and export workspace resources, and invite partners with Viewer access to the workspace",
46         "displayName": "Viewer and Partner Lead"
47       },
48       {
49         "id": "5",
50         "description": "Can create, edit and fork workspace resources",
51         "displayName": "Editor"
52       },
53       {
54         "id": "4",
55         "description": "Can send requests and view workspace resources",
56         "displayName": "Viewer"
57       }
58     ]
59   }
60 }

Gets information about all roles in a workspace, based on the team’s plan.

Gets information about all roles in a workspace, based on the team's [plan](https://www.postman.com/pricing/).

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)>.

Response

Successful Response

rolesobject

Information about the workspace's roles.

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error