User Groups V2

Update User Group Roles

Changed on

Use this API to update the roles of a user group by replacing the current set of roles with a new one.

put/api/access/v2/user-groups/{groupId}/access-levels

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/access/v2/user-groups/{groupId}/access-levels
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: USER, USER_GROUP_WRITE

Path parameters

groupIdstring uuid required

The unique identifier of the user group.

Request body

currentOrganizationIdstring uuid required

The unique identifier of the organization currently associated with the user group.

currentRoleIdstring uuid required

The unique identifier of the role currently associated with the user group.

newOrganizationIdstring uuid required

The unique identifier of the replacement organization.

newRoleIdstring uuid required

The unique identifier of the replacement role.

Example request

{
  "currentOrganizationId": "323e4567-e89b-12d3-a456-426614174000",
  "currentRoleId": "823e4567-e89b-12d3-a456-426614174000",
  "newOrganizationId": "923e4567-e89b-12d3-a456-426614174000",
  "newRoleId": "813e4567-e89b-12d3-a456-426614174000"
}

Response

Access level updated successfully

Changes

    • info

      the security scope USER_GROUP_WRITE was added to the endpoint's security scheme Platform-AccessManagement_OAUTH2