Get permissions for current user

Get device and functionality permissions for user or API token

POST /api/permission/getPermissionsForCurrentUser

Get permissions for current user

cURL

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

200

{
  "accessControlLocationAccessMap": {},
  "accessMap": {},
  "assignablePermissionGroups": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "componentCompositeGranularAccessMap": {},
  "deviceAccessMap": {},
  "error": true,
  "errorMsg": "<string>",
  "functionalityList": [],
  "installer": false,
  "locationAccessMap": {},
  "locationGranularAccessMap": {},
  "permissionGroupName": "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 user.

Response

200 - application/json

OK

Response object containing comprehensive permission information for the current user including functionality, device, location, and granular access maps.

accessControlLocationAccessMap · object

Map of access control location UUIDs to permission levels

Show child attributes

accessMap · object

Deprecated: Map of device UUIDs to permission levels (use deviceAccessMap instead)

Show child attributes

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

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

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

componentCompositeGranularAccessMap · object

Map of component composite UUIDs to granular functionality permission maps. Functionality keys are LocationFunctionality values (normalized from ComponentCompositeFunctionality via ComponentCompositeFunctionality#getLocationFunctionality).

Show child attributes

deviceAccessMap · object

Map of device UUIDs to permission levels

Show child attributes

error · boolean | null

errorMsg · string | null

functionalityList · enum<string>[] | null

List of 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

installer · boolean | null

Whether the user has installer privileges

Example:

false

locationAccessMap · object

Map of location UUIDs to permission levels

Show child attributes

locationGranularAccessMap · object

Map of location UUIDs to granular functionality permission maps

Show child attributes

permissionGroupName · string | null

Name of the user's permission group

Example:

"Administrator"

superAdmin · boolean | null

Whether the user has super admin privileges

Example:

false

warningMsg · string | null