Update workspace roles

PATCH

/workspaces/:workspaceId/roles

PATCH

/workspaces/:workspaceId/roles

$ curl -X PATCH https://api.getpostman.com/workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9/roles \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json-patch+json" \
>      -d '{
>   "roles": [
>     {
>       "op": "add",
>       "path": "/user",
>       "value": [
>         {
>           "id": "12345678",
>           "role": "1"
>         },
>         {
>           "id": "87654321",
>           "role": "2"
>         }
>       ]
>     },
>     {
>       "op": "remove",
>       "path": "/user",
>       "value": [
>         {
>           "id": "87612345",
>           "role": "1"
>         }
>       ]
>     },
>     {
>       "op": "add",
>       "path": "/usergroup",
>       "value": [
>         {
>           "id": "123",
>           "role": "2"
>         }
>       ]
>     },
>     {
>       "op": "remove",
>       "path": "/usergroup",
>       "value": [
>         {
>           "id": "312",
>           "role": "3"
>         }
>       ]
>     }
>   ]
> }'

1 {
2   "roles": [
3     {
4       "id": "1",
5       "user": [
6         "12345678"
7       ],
8       "group": [
9         "123"
10       ],
11       "displayName": "Viewer"
12     },
13     {
14       "id": "2",
15       "user": [
16         "87654321"
17       ],
18       "group": [
19         "123"
20       ],
21       "displayName": "Editor"
22     },
23     {
24       "id": "3",
25       "user": [
26         "13428756"
27       ],
28       "group": [
29         "132"
30       ],
31       "displayName": "Admin"
32     }
33   ]
34 }

Updates the roles of users, user groups, or partners in a workspace. To get a list of roles, use the GET /workspace-roles endpoint. To get a group ID, use the GET /groups endpoint.

Note:

User groups are available on Postman Enterprise plans.
To use SCIM IDs for users and user groups, include the identifierType=scim header when you call this endpoint. To get SCIM user IDs, include the include=scim query parameter when calling the GET /workspaces/{workspaceId} or GET /workspaces endpoints.
You can’t set roles for users in personal workspaces.
This endpoint doesn’t support the external Guest role.
The partner Editor and Editor and Partner Lead roles aren’t supported in multi-partner workspaces.
You can’t update partner and user roles in the same operation.
This endpoint is restricted to 50 operations per call.
The request body must contain one unique action per user, user group, or partner. For example, you cannot add and remove multiple roles for a user in the same request body.

Updates the roles of users, [user groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/), or partners in a workspace. To get a list of roles, use the GET `/workspace-roles` endpoint. To get a group ID, use the GET `/groups` endpoint. **Note:** - User groups are available on Postman [**Enterprise** plans](https://www.postman.com/pricing). - To use SCIM IDs for users and user groups, include the `identifierType=scim` header when you call this endpoint. To get SCIM user IDs, include the `include=scim` query parameter when calling the GET `/workspaces/{workspaceId}` or GET `/workspaces` endpoints. - You can't set roles for users in personal workspaces. - This endpoint doesn't support the external [Guest role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles). - The partner **Editor** and **Editor and Partner Lead** roles aren't supported in multi-partner workspaces. - You can't update partner and user roles in the same operation. - This endpoint is restricted to 50 operations per call. - The request body must contain one unique action per user, user group, or partner. For example, you cannot add and remove multiple roles for a user in the same request body.

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

workspaceIdstringRequired

The workspace's ID.

Request

This endpoint expects an object.

roleslist of objectsOptional

Response

Successful Response

roleslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors