Sign in

v1

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

Create User Group

Use this API to create a new user group with a specified name and description.

post/api/access/v2/user-groups

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 created successfully

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