Skip to main content
POST
/
api
/
accesscontrol
/
lockdownPlan
/
findLockdownPlans
Find lockdown plans in the org
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 '{}'
{
  "lockdownPlans": [
    {
      "activationPlan": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "rhombusKeyNotificationMessage": "<string>",
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "createdAtMillis": 123,
      "deactivationPlan": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "rhombusKeyNotificationMessage": "<string>",
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "defaultLockdownState": "LOCKED_DOWN",
      "doorLockdownStateMap": {},
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "physicalAccess": {
        "groupUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "userUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "testPlan": {
        "doorStateOverrideEnabled": true,
        "userAccessOverrideEnabled": true
      },
      "type": "ORG_LOCKDOWN",
      "updatedAtMillis": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

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.