Lockdown Plan

Create location lockdown plan

POST/api/accesscontrol/lockdownPlan/createLocationLockdownPlan

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 write 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 to create a new location lockdown plan.

lockdownPlanobjectbody

The updated location lockdown plan.

Show child attributes

activationPlanobjectbody

Show child attributes

groupUuidsstring<RUUID>[] | nullbody

rhombusKeyNotificationMessagestring | nullbody

userUuidsstring<RUUID>[] | nullbody

createdAtMillisinteger<int64> | nullbody

deactivationPlanobjectbody

Show child attributes

groupUuidsstring<RUUID>[] | nullbody

rhombusKeyNotificationMessagestring | nullbody

userUuidsstring<RUUID>[] | nullbody

defaultLockdownStateenum<string>body

Available options: LOCKED_DOWN, ACCESS_CONTROLLED, UNLOCKED, UNKNOWN

doorLockdownStateMapobject | nullbody

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

namestring | nullbody

orgUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

physicalAccessobjectbody

Show child attributes

groupUuidsstring<RUUID>[] | nullbody

userUuidsstring<RUUID>[] | nullbody

scopeUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

testPlanobjectbody

Show child attributes

doorStateOverrideEnabledboolean | nullbody

userAccessOverrideEnabledboolean | nullbody

typeenum<string>body

Available options: ORG_LOCKDOWN, LOCATION_LOCKDOWN

updatedAtMillisinteger<int64> | nullbody

uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "lockdownPlan": {
      "activationPlan": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "rhombusKeyNotificationMessage": "<string>",
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "createdAtMillis": 0,
      "deactivationPlan": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "rhombusKeyNotificationMessage": "<string>",
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "defaultLockdownState": "LOCKED_DOWN",
      "doorLockdownStateMap": {
        "<key>": "LOCKED_DOWN"
      },
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "physicalAccess": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "testPlan": {
        "doorStateOverrideEnabled": true,
        "userAccessOverrideEnabled": true
      },
      "type": "ORG_LOCKDOWN",
      "updatedAtMillis": 0,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  }'

import requests

url = "https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "lockdownPlan": {
        "activationPlan": {
            "groupUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "rhombusKeyNotificationMessage": "<string>",
            "userUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
            ]
        },
        "createdAtMillis": 0,
        "deactivationPlan": {
            "groupUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "rhombusKeyNotificationMessage": "<string>",
            "userUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
            ]
        },
        "defaultLockdownState": "LOCKED_DOWN",
        "doorLockdownStateMap": {
            "<key>": "LOCKED_DOWN"
        },
        "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "name": "<string>",
        "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "physicalAccess": {
            "groupUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "userUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
            ]
        },
        "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "testPlan": {
            "doorStateOverrideEnabled": True,
            "userAccessOverrideEnabled": True
        },
        "type": "ORG_LOCKDOWN",
        "updatedAtMillis": 0,
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
}

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

const response = await fetch('https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "lockdownPlan": {
      "activationPlan": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "rhombusKeyNotificationMessage": "<string>",
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "createdAtMillis": 0,
      "deactivationPlan": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "rhombusKeyNotificationMessage": "<string>",
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "defaultLockdownState": "LOCKED_DOWN",
      "doorLockdownStateMap": {
        "<key>": "LOCKED_DOWN"
      },
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "physicalAccess": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "testPlan": {
        "doorStateOverrideEnabled": true,
        "userAccessOverrideEnabled": true
      },
      "type": "ORG_LOCKDOWN",
      "updatedAtMillis": 0,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  }),
});
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 = """
            {
              "lockdownPlan": {
                "activationPlan": {
                  "groupUuids": [
                    "AAAAAAAAAAAAAAAAAAAAAA"
                  ],
                  "rhombusKeyNotificationMessage": "<string>",
                  "userUuids": [
                    "AAAAAAAAAAAAAAAAAAAAAA"
                  ]
                },
                "createdAtMillis": 0,
                "deactivationPlan": {
                  "groupUuids": [
                    "AAAAAAAAAAAAAAAAAAAAAA"
                  ],
                  "rhombusKeyNotificationMessage": "<string>",
                  "userUuids": [
                    "AAAAAAAAAAAAAAAAAAAAAA"
                  ]
                },
                "defaultLockdownState": "LOCKED_DOWN",
                "doorLockdownStateMap": {
                  "<key>": "LOCKED_DOWN"
                },
                "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "name": "<string>",
                "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "physicalAccess": {
                  "groupUuids": [
                    "AAAAAAAAAAAAAAAAAAAAAA"
                  ],
                  "userUuids": [
                    "AAAAAAAAAAAAAAAAAAAAAA"
                  ]
                },
                "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "testPlan": {
                  "doorStateOverrideEnabled": true,
                  "userAccessOverrideEnabled": true
                },
                "type": "ORG_LOCKDOWN",
                "updatedAtMillis": 0,
                "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
              }
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan"))
            .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

{
  "lockdownPlan": {
    "activationPlan": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombusKeyNotificationMessage": "<string>",
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "createdAtMillis": 0,
    "deactivationPlan": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombusKeyNotificationMessage": "<string>",
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "defaultLockdownState": "LOCKED_DOWN",
    "doorLockdownStateMap": {
      "<key>": "LOCKED_DOWN"
    },
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "physicalAccess": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "testPlan": {
      "doorStateOverrideEnabled": true,
      "userAccessOverrideEnabled": true
    },
    "type": "ORG_LOCKDOWN",
    "updatedAtMillis": 0,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Response

200 OK

application/json · object

Response containing the created location lockdown plan.

lockdownPlanobject

The updated location lockdown plan.

Show child attributes

activationPlanobject

Show child attributes

groupUuidsstring<RUUID>[] | null

rhombusKeyNotificationMessagestring | null

userUuidsstring<RUUID>[] | null

createdAtMillisinteger<int64> | null

deactivationPlanobject

Show child attributes

groupUuidsstring<RUUID>[] | null

rhombusKeyNotificationMessagestring | null

userUuidsstring<RUUID>[] | null

defaultLockdownStateenum<string>

Available options: LOCKED_DOWN, ACCESS_CONTROLLED, UNLOCKED, UNKNOWN

doorLockdownStateMapobject | null

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

physicalAccessobject

Show child attributes

groupUuidsstring<RUUID>[] | null

userUuidsstring<RUUID>[] | null

scopeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

testPlanobject

Show child attributes

doorStateOverrideEnabledboolean | null

userAccessOverrideEnabledboolean | null

typeenum<string>

Available options: ORG_LOCKDOWN, LOCATION_LOCKDOWN

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

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.