ADT · Schema

Credential

An access control credential.

Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Properties

Name Type Description
id string Unique identifier of the credential.
userId string ID of the user this credential belongs to.
type string Type of credential.
status string Credential status.
validFrom string Start of credential validity period.
validTo string End of credential validity period.
View JSON Schema on GitHub

JSON Schema

business-api-credential-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-schema.json",
  "title": "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": "string",
      "format": "date-time",
      "description": "Start of credential validity period."
    },
    "validTo": {
      "type": "string",
      "format": "date-time",
      "description": "End of credential validity period."
    }
  }
}