Skip to main content
POST
/
api
/
permission
/
getPermissionGroups
Get permission groups
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 '{}'
{
  "error": true,
  "errorMsg": "<string>",
  "groupMembership": {},
  "partnerMembership": {},
  "permissionGroups": [
    {
      "accessControlLocationAccessMap": {},
      "accessibleLocations": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "assignablePermissionGroups": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "defaultAccessControlPermissionForNewLocations": "READONLY",
      "defaultPermissionForNewLocations": "READONLY",
      "description": "<string>",
      "deviceAccessMap": {},
      "functionalityList": [
        "DEVICE_ADMINISTRATION"
      ],
      "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 API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

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

partnerMembership
object

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

permissionGroups
object[] | null

List of permission groups in the organization

warningMsg
string | null