ONonetrust
User Groups V2

Add Multiple Users to User Group

Changed on

Use this API to add multiple users to a specified user group in bulk.

post/api/access/v2/user-groups/{groupId}/members

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/access/v2/user-groups/{groupId}/members
  • 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

membersstring[] required

The list of user identifiers to be added to the user group.

Example request

{
  "members": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

Response

Members added successfully

Changes

  • df80c4b8e947Revision changes
    • breaking

      the request property became required

    • info

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