ONonetrust
User Groups

Add Members to User Group

Changed on

Use this API to add users as members of a specific user group.

🗒 Things to Know

  • When a user is added as a member of a user group, the user inherits the role and organization configured for that user group. If the user belongs to other user groups, the user will still retain existing membership with those groups in addition to their other existing roles and permissions.
  • The userId of the users to be added to the user group can be specified in the request body in a comma separated list.
post/api/access/v1/user-groups/{userGroupId}/members

Request

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

Path parameters

userGroupIdstring 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.

groupIdstring uuid

The unique identifier of the user group.

Example request

{
  "members": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "groupId": "a739211d-d216-4398-a1c2-f7a20412692d"
}

Response

Created

Changes

  • df80c4b8e947Revision changes
    • breaking

      the request property became required

    • breaking

      the request property's minItems was increased to 1

    • breaking

      the / request property's minItems was increased to 1

    • info

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