Get permission groups

Get details about all permission groups in organization

POST /api/permission/getPermissionGroups

Get permission groups

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/permission/getPermissionGroups \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'

200

{
  "error": true,
  "errorMsg": "<string>",
  "groupMembership": {},
  "partnerMembership": {},
  "permissionGroups": [
    {
      "accessControlLocationAccessMap": {},
      "accessibleLocations": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "assignablePermissionGroups": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "componentCompositeGranularAccessMap": {},
      "description": "<string>",
      "deviceAccessMap": {},
      "functionalityList": [],
      "inLine": true,
      "installer": true,
      "locationAccessMap": {},
      "locationGranularAccessMap": {},
      "mutable": true,
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "storedInS3": true,
      "superAdmin": true,
      "userPermissionGroupAccessMap": {},
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting all permission groups in the organization.

Response

200 - application/json

OK

Response object containing permission groups and membership information for the organization.

error · boolean | null

errorMsg · string | null

groupMembership · object

Map of permission group UUIDs to list of user UUIDs in each group

Show child attributes

partnerMembership · object

Map of partner UUIDs to list of user UUIDs in each partner organization

Show child attributes

permissionGroups · object[] | null

List of permission groups in the organization

Show child attributes

warningMsg · string | null