accessmanagement - resource groups

Lists the user groups assigned to a specific resource group.

This endpoint lists the user groups assigned to a specific resource group, providing users with insight into access management.</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 user groups, ensuring accuracy and relevance in the response.

get/accessmanagement/resourcegroups/{resourceGroupId}/usergroups

Request

Path parameters

resourceGroupIdinteger required

Filters data by the resource group’s unique identifier.

Query parameters

type'user' | 'service'

Filters the users by type

Response

User groups listed successfully.

totalinteger
countinteger
perPageinteger
currentPageinteger
totalPagesinteger

Example response

{
  "data": [
    {
      "userGroup": {
        "id": 1,
        "name": "Default",
        "description": "User group description",
        "isDefault": true,
        "membersCount": 21,
        "users": [
          {
            "id": 1,
            "name": "John Doe",
            "email": "john@doe.com",
            "username": "johndoe",
            "oneloginUserId": "randomIdString",
            "created_ts": "2024-12-18T14:06:21.111477+02:00",
            "modified_ts": "2024-12-18T14:06:21.111477+02:00",
            "status": true,
            "roles": [
              {
                "id": 3,
                "name": "Admin",
                "description": "Administrator role with full permissions"
              }
            ],
            "resourceGroups": [
              {
                "id": 2,
                "name": "Default",
                "description": "Default resource group",
                "isDefault": true
              }
            ],
            "userGroups": [
              {
                "id": 1,
                "name": "Default",
                "description": "Default user group",
                "isDefault": true
              }
            ]
          }
        ]
      },
      "roles": [
        {
          "id": 6,
          "name": "Viewer",
          "description": "Viewer role"
        }
      ]
    }
  ],
  "total": 25,
  "count": 10,
  "perPage": 10,
  "totalPages": 3
}

Changes

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