Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
User Groups

Update User Group

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

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

Path parameters

userGroupIdstring uuid required

The unique identifier of the user group.

Request body

namestring

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"
}