ADT · Schema

CredentialList

List of access credentials.

Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Properties

Name Type Description
credentials array Array of credentials.
View JSON Schema on GitHub

JSON Schema

business-api-credential-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-schema/business-api-credential-list-schema.json",
  "title": "CredentialList",
  "description": "List of access credentials.",
  "type": "object",
  "properties": {
    "credentials": {
      "type": "array",
      "description": "Array of credentials.",
      "items": {
        "type": "object",
        "description": "An access control credential.",
        "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": "string",
            "format": "date-time",
            "description": "Start of credential validity period."
          },
          "validTo": {
            "type": "string",
            "format": "date-time",
            "description": "End of credential validity period."
          }
        }
      }
    }
  }
}