Permission Webservice

Get permissions for current user

Get device and functionality permissions for user or API token

post/api/permission/getPermissionsForCurrentUser

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/permission/getPermissionsForCurrentUser
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

PermissionGetPermissionsForCurrentUserWSRequest required

Request object for getting permissions for the current user.

Response

OK

accessControlLocationAccessMapobject nullable

Map of access control location UUIDs to permission levels

accessMapobject nullable

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

assignablePermissionGroupsstring[] nullable

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

componentCompositeGranularAccessMapobject nullable

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

deviceAccessMapobject nullable

Map of device UUIDs to permission levels

errorboolean nullable
errorCodestring nullable

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

errorMsgstring nullable
functionalityListFunctionalityEnum[] nullable

List of functionalities the user has access to

installerboolean nullable

Whether the user has installer privileges

locationAccessMapobject nullable

Map of location UUIDs to permission levels

locationGranularAccessMapobject nullable

Map of location UUIDs to granular functionality permission maps

permissionGroupNamestring nullable

Name of the user's permission group

superAdminboolean nullable

Whether the user has super admin privileges

warningMsgstring nullable

Example response

{
  "assignablePermissionGroups": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "permissionGroupName": "Administrator"
}

Changes

No recorded changes to this operation across all 1 revision of this API.