User Groups V2

Get User Group Roles

Changed on

Use this API to retrieve a list of roles for a specific user group.

get/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_READ

Path parameters

groupIdstring uuid required

The unique identifier of the user group.

Response

Access levels retrieved successfully

organizationIdstring uuid

The unique identifier of the organization.

organizationNamestring

The name of the organization.

roleIdstring uuid

The unique identifier of the role.

roleNamestring

The name of the role.

Example response

[
  {
    "organizationId": "423e4567-e89b-12d3-a456-426614174000",
    "organizationName": "My Org",
    "roleId": "423e4567-e89b-12d3-a456-426614174001",
    "roleName": "Audit Manager"
  }
]

Changes

    • info

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