API Reference

Sections

CredentialReader

antiPassbackDurationInMillisecondsint

The duration, in milliseconds, that a credential is temporarily disabled after each read (anti-passback).

bleCredentialsobject

Settings related to reading Bluetooth Low Energy (BLE) credentials.

Show child attributes

bruteForceAttackMitigationIsEnabledboolean

When true, indicates the reader will temporarily disable credential reading to mitigate brute-force attacks.

doubleTapIsEnabledboolean

When true, indicates credentials are enabled to act as toggle credentials when double tapped to the reader.

iso14443Credentialsobject

Information on current settings for reading contactless credentials using ISO 14443 protocols.

Show child attributes

iso15693Credentialsobject

Information on current settings for reading contactless credentials using ISO 15693 protocols.

Show child attributes

nfcConfigCardsobject

Information on current settings for reading NFC config cards.

Show child attributes

noTourobject

Settings related to reading Schlage ENGAGE No Tour credentials.

Show child attributes

{
  "antiPassbackDurationInMilliseconds": null,
  "bleCredentials": {
    "areEnabled": false,
    "performance": {
      "isMaximum": false,
      "isNormal": false
    },
    "range": {
      "isLong": false,
      "isShort": false
    }
  },
  "bruteForceAttackMitigationIsEnabled": false,
  "doubleTapIsEnabled": false,
  "iso14443Credentials": {
    "mode": {
      "isDisabled": false,
      "readSecureSector": false,
      "readUidOnly": false
    },
    "technologies": {
      "isAndroidHceEnabled": false,
      "isAppleNfcEnabled": false,
      "isMifare2GoEnabled": false,
      "isMifareClassicEnabled": false,
      "isMifareDesfireEnabled": false,
      "isMifareDesfireLightEnabled": false
    }
  },
  "iso15693Credentials": {
    "mode": {
      "isDisabled": false,
      "uidOnly": false
    },
    "technologies": {
      "isHIDiClass40BitWithParityEnabled": false,
      "isHIDiClass64BitMsbEnabled": false,
      "isHIDiClassSymmetricCryptographicSecurityEnabled": false
    }
  },
  "nfcConfigCards": {
    "areEnabled": false
  },
  "noTour": {
    "doorId": null,
    "groupIds": null,
    "isEnabled": false,
    "remainingCredentialCount": null,
    "siteKeyShaHash": null
  }
}

Sections

CredentialReader

CredentialReaderExpand all

CredentialReader