accessmanagement - user groups

Updates a specific user group.

This endpoint updates a specific user group, enabling users to modify its properties or membership as needed.</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>- Reliable user group updates: Facilitates the modification of a specific user group, ensuring accurate and up-to-date information across the system.</br>- Targeted data updates: Leverages the userGroupId parameter in the URL path to update the specified user group, ensuring accurate and focused modifications.

put/accessmanagement/usergroups/{userGroupId}

Request

Path parameters

userGroupIdinteger required

Filters data by the user group’s unique identifier.

Request body

namestring
descriptionstring

Example request

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

Response

User group updated successfully.

idinteger
namestring
descriptionstring
canDeleteboolean
canRenameboolean
isDefaultboolean
memberCountinteger
resourceGroupsCountinteger

Example response

{
  "id": 27,
  "name": "Default",
  "description": "Default user group",
  "canRename": true,
  "isDefault": true,
  "resourceGroupsCount": 20,
  "resourceGroupSummary": [
    {
      "name": "Default resource group",
      "id": 128,
      "roles": [
        {
          "id": 3,
          "name": "Admin",
          "description": "Administrator role with full permissions",
          "roleType": "System Role",
          "userCount": 1,
          "modifiedTs": "2025-09-01T15:37:56.338909+02:00",
          "createdTs": "2025-09-01T15:37:56.338859+02:00"
        }
      ]
    }
  ]
}

Changes

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