accessmanagement - user groups

Creates a new user group.

This endpoint creates a new user group, allowing users to define and organize groups based on specific access or collaboration needs.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive error handling: Returns a 400 error code with a clear description when requests fail.</br>- Seamless user group creation: Facilitates the creation of a user group in-line with the appropriate schema, ensuring smooth and efficient organization.

post/accessmanagement/usergroups

Request

Request body

namestring
descriptionstring

Example request

{
  "name": "Default",
  "description": "User group description."
}

Response

User group created successfully.

idinteger
namestring
descriptionstring
canDeleteboolean
canRenameboolean
isDefaultboolean
memberCountinteger
resourceGroupsCountinteger
resourceGroupSummarystring[]

Example response

{
  "id": 27,
  "name": "Default",
  "description": "Default user group",
  "canRename": true,
  "isDefault": true,
  "resourceGroupsCount": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.