Get permissions for current partner

Get permissions for the current partner user

POST /api/permission/getPermissionsForCurrentPartner

Get permissions for current partner

cURL

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

200

{
  "assignablePermissionGroups": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "clientFunctionalityList": [],
  "clientPermissionMap": {},
  "error": true,
  "errorMsg": "<string>",
  "functionalityList": [],
  "permissionGroupName": "Partner Administrator",
  "superAdmin": false,
  "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 permissions for the current partner user.

Response

200 - application/json

OK

Response object containing partner permission information including functionality lists, client permissions, and group details.

assignablePermissionGroups · (string<RUUID> | null)[] | null

Set of partner permission group UUIDs the user can assign to other users

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

clientFunctionalityList · enum<string>[] | null

List of client functionalities the user has access to

Available options: DEVICE_ADMINISTRATION, ORG_ADMINISTRATION, AUTH_ADMINISTRATION, FIRMWARE_ADMINISTRATION, DOOR_ACCESS_ADMINISTRATION, CAMERA_ADMINISTRATION, REGISTER_DEVICES, DELETE_DEVICES, LOCATION_ADMINISTRATION, POLICY_ADMINISTRATION, USER_ADMINISTRATION, REPORT_ADMINISTRATION, NOTIFICATION_ADMINISTRATION, LICENSE_ADMINISTRATION, RECEIVE_EMAILS, MANAGE_FACES, MANAGE_LICENSEPLATES, API_ADMINISTRATION, INTEGRATION_ADMINISTRATION, DATA_EXFILTRATION, ALERT_MONITORING_ADMINISTRATION, ALERT_MONITORING_VIEWONLY, GUEST_MANAGEMENT_ADMINISTRATION, GUEST_MANAGEMENT_VIEWONLY, CLIP_MANAGEMENT, VIEW_SAVED_VIDEO, VIEW_AND_MANAGE_SAVED_VIDEO, CLLM_ADMINISTRATION, UNKNOWN

clientPermissionMap · object

Map of client UUIDs to partner permission levels

Show child attributes

error · boolean | null

errorMsg · string | null

functionalityList · enum<string>[] | null

List of partner functionalities the user has access to

Available options: CREATE_CLIENT, DELETE_CLIENT, DEAL_ADMINISTRATION, REMOTE_REGISTER_DEVICE, ORG_ADMINISTRATION, AUTH_ADMINISTRATION, DOOR_ACCESS_ADMINISTRATION, USER_ADMINISTRATION, REPORT_ADMINISTRATION, NOTIFICATION_ADMINISTRATION, LICENSE_ADMINISTRATION, RECEIVE_EMAILS, API_ADMINISTRATION, INTEGRATION_ADMINISTRATION, DATA_EXFILTRATION, CLIP_MANAGEMENT, UNKNOWN

permissionGroupName · string | null

Name of the partner user's permission group

Example:

"Partner Administrator"

superAdmin · boolean | null

Whether the partner user has super admin privileges

Example:

false

warningMsg · string | null