ONonetrust
User Groups V2

Update User Group

Changed on

Use this API to update the attributes of an existing user group by its unique identifier.

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

Request

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

namestring required

The name of the user group.

descriptionstring

The description of the user group.

Example request

{
  "name": "My User Group",
  "description": "User group used for grouping users"
}

Response

User group attributes by identifier is successfully updated

idstring uuid

The internal identifier of the user group.

namestring

The name of the user group.

descriptionstring

The description of the user group.

createdBystring uuid

The unique identifier of the user who created the user group.

createdDatestring date-time

The timestamp of when the user group was created.

lastModifiedBystring uuid

The unique identifier of the user who last modified the user group.

lastModifiedDatestring date-time

The timestamp of when the user group was last modified.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My User Group",
  "description": "User group used for grouping users",
  "createdBy": "52b6b7df-9e69-4d6f-9fd3-75c1d4626366",
  "createdDate": "2022-05-01T12:34:56Z",
  "lastModifiedBy": "52b6b7df-9e69-4d6f-9fd3-75c1d4626366",
  "lastModifiedDate": "2022-05-01T12:34:56Z"
}

Changes

  • df80c4b8e947Revision changes
    • info

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