ONonetrust
User Groups

Update User Group

Changed on

Use this API to update the name and description of a specific user group.

put/api/access/v1/user-groups/{userGroupId}

Request

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

namestring required

The name of the user group.

descriptionstring

A brief description of the user group.

Example request

{
  "name": "Administrators",
  "description": "Group for system administrators"
}

Response

OK

userGroupIdstring uuid

The unique identifier of the user group.

namestring

The name of the user group.

descriptionstring

The brief description of the user group.

createdBystring uuid

The unique identifier of the user who created this record.

createdDatestring date-time

The date and time the record was created.

lastModifiedBystring uuid

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

lastModifiedDatestring date-time

The date and time the record was last modified.

Example response

{
  "userGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Administrators",
  "description": "Group for system administrators",
  "createdBy": "123e4567-e89b-12d3-a456-426614174001",
  "createdDate": "2022-05-01T12:34:56Z",
  "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174001",
  "lastModifiedDate": "2022-05-01T12:34:56Z"
}

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