Skip to main content
POST
/
api
/
permission
/
getPartnerPermissionGroups
Get partner permission groups
curl --request POST \
  --url https://api2.rhombussystems.com/api/permission/getPartnerPermissionGroups \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "clientPermissionGroupMap": {},
  "error": true,
  "errorMsg": "<string>",
  "groupMembership": {},
  "permissionGroups": [
    {
      "assignablePermissionGroups": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "clientAssignablePermissionGroupsMap": {},
      "clientFunctionalityList": [
        "DEVICE_ADMINISTRATION"
      ],
      "clientPermissionMap": {},
      "description": "<string>",
      "functionalityList": [
        "CREATE_CLIENT"
      ],
      "mutable": true,
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "superAdmin": true,
      "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 partner permission groups for the organization.

Response

200 - application/json

OK

Response object containing partner permission groups and client permission group mappings.

clientPermissionGroupMap
object

Map of client UUIDs to their permission group types

error
boolean | null
errorMsg
string | null
groupMembership
object

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

permissionGroups
object[] | null

List of partner permission groups

warningMsg
string | null