Update user or user group roles

PATCH {{baseUrl}}/workspaces/{{workspaceId}}/roles

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

Include the following values in the roles array of objects:

• op — (Required) A string value that contains the operation to perform. Accepts the add or remove value.

• path — (Required) A string value that contains the resource to perform the action on. Accepts the /user or /usergroup value.

• value — (Required) A list of objects that contain user or user group IDs and an assigned role ID.

  • id — (Required) A string value that contains the user or user group ID. To use SCIM IDs for users or groups, include the identifierType=scim header in the request.

  • role — (Required) A number value that contains the workspace role's ID:

    • 1 — Viewer. Can view, fork, and export workspace resources
    • 2 — Editor. Can create and edit workspace resources.
    • 3 — Admin. Can manage workspace details and members.

Note:

• To use SCIM IDs, include the identifierType=scim header when you call this endpoint. To get SCIM user IDs, use the include=scim query parameter when calling the [GET /workspaces/{workspaceId}] or [GET /workspaces] endpoints.

• You cannot set roles for users in personal and partner workspaces.

• This endpoint does not support the external [Partner or Guest roles]

• This endpoint is restricted to 50 operations per call.

• The request body must contain one unique action per user or user group. For example, you cannot add and remove multiple roles for a user in the same request body.

HEADERS

RESPONSES

status: OK

{"roles":[{"displayName":"Admin","group":["561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00"],"user":["e982929dadd02cf627e8c111925fc37a93dbc86f510840db"],"id":3}]}