Find lockdown plans in the org

Find lockdown plans in the org

POST /api/accesscontrol/lockdownPlan/findLockdownPlans

Find lockdown plans in the org

cURL

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

200

{
  "lockdownPlans": [
    {
      "activationPlan": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "rhombusKeyNotificationMessage": "<string>",
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "createdAtMillis": 123,
      "deactivationPlan": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "rhombusKeyNotificationMessage": "<string>",
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "doorLockdownStateMap": {},
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "physicalAccess": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "testPlan": {
        "doorStateOverrideEnabled": true,
        "userAccessOverrideEnabled": true
      },
      "updatedAtMillis": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

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 to search for lockdown plans across the organization.

Response

200 - application/json

OK

Response containing a list of lockdown plans found in the organization.

lockdownPlans · object[] | null

List of lockdown plans found in the organization.

Show child attributes