Permission

Get permissions for current user

Get device and functionality permissions for user or API token

POST/api/permission/getPermissionsForCurrentUser

Authorizations

x-auth-apikeystringheaderrequired

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

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

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

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for getting permissions for the current user.

bash

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

import requests

url = "https://api2.rhombussystems.com/api/permission/getPermissionsForCurrentUser"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/permission/getPermissionsForCurrentUser', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/permission/getPermissionsForCurrentUser"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "accessControlLocationAccessMap": {
    "<key>": "READONLY"
  },
  "accessMap": {
    "<key>": "READONLY"
  },
  "assignablePermissionGroups": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "componentCompositeGranularAccessMap": {
    "<key>": {
      "<key>": "READONLY"
    }
  },
  "deviceAccessMap": {
    "<key>": "READONLY"
  },
  "error": false,
  "errorCode": "<string>",
  "functionalityList": [
    "DEVICE_ADMINISTRATION"
  ],
  "installer": false,
  "locationAccessMap": {
    "<key>": "READONLY"
  },
  "locationGranularAccessMap": {
    "<key>": {
      "<key>": "READONLY"
    }
  },
  "permissionGroupName": "Administrator",
  "superAdmin": false
}

Response

200 OK

application/json · object

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

accessControlLocationAccessMapobject | null

Map of access control location UUIDs to permission levels

accessMapobject | null

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

assignablePermissionGroupsstring<RUUID>[] | null

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

componentCompositeGranularAccessMapobject | null

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

deviceAccessMapobject | null

Map of device UUIDs to permission levels

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

functionalityListenum<string>[] | null

List of functionalities the user has access to

installerboolean | null

Whether the user has installer privileges

Example: false

locationAccessMapobject | null

Map of location UUIDs to permission levels

locationGranularAccessMapobject | null

Map of location UUIDs to granular functionality permission maps

permissionGroupNamestring | null

Name of the user's permission group

Example: "Administrator"

superAdminboolean | null

Whether the user has super admin privileges

Example: false

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.