ADT · JSON Structure

Business Api Credential Structure

An access control credential.

Type: object Properties: 6
Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Credential is a JSON Structure definition published by ADT, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id userId type status validFrom validTo

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-structure/business-api-credential-structure.json",
  "name": "Credential",
  "description": "An access control credential.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the credential.",
      "example": "cred-001"
    },
    "userId": {
      "type": "string",
      "description": "ID of the user this credential belongs to.",
      "example": "usr-001"
    },
    "type": {
      "type": "string",
      "description": "Type of credential.",
      "enum": [
        "badge",
        "pin",
        "biometric",
        "mobile"
      ],
      "example": "badge"
    },
    "status": {
      "type": "string",
      "description": "Credential status.",
      "enum": [
        "active",
        "suspended",
        "expired"
      ],
      "example": "active"
    },
    "validFrom": {
      "type": "datetime",
      "description": "Start of credential validity period."
    },
    "validTo": {
      "type": "datetime",
      "description": "End of credential validity period."
    }
  }
}