ADT · JSON Structure

Business Api Credential List Structure

List of access credentials.

Type: object Properties: 1
Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

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

Properties

credentials

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-list-structure.json",
  "name": "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": "datetime",
            "description": "Start of credential validity period."
          },
          "validTo": {
            "type": "datetime",
            "description": "End of credential validity period."
          }
        }
      }
    }
  }
}