accessmanagement - resource groups

Lists the unassigned user groups of a specific resource group.

This endpoint lists the user groups not currently assigned to a specific resource group, helping users identify available groups for assignment.</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 400 and 404 error codes with clear descriptions when requests fail.</br>- Targeted data retrieval: Employs the resourceGroupId parameter to return the specified resource group's unassigned user groups, ensuring accuracy and relevance in the response.

get/accessmanagement/resourcegroups/{resourceGroupId}/usergroups/unassigned

Request

Path parameters

resourceGroupIdinteger required

Filters data by the resource group’s unique identifier.

Response

User groups listed successfully.

totalinteger
countinteger
perPageinteger
currentPageinteger
totalPagesinteger

Example response

{
  "data": [
    {
      "id": 27,
      "name": "Default",
      "description": "Default user group",
      "resourceGroupSummary": [
        {
          "name": "Default resource group",
          "id": 128,
          "roles": {
            "id": 3,
            "name": "Admin",
            "description": "Administrator role with full permissions"
          }
        }
      ]
    }
  ],
  "total": 25,
  "count": 10,
  "perPage": 10,
  "totalPages": 3
}

Changes

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