ADT · Schema

CredentialInput

Request to create an access credential.

Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Properties

Name Type Description
userId string ID of the user.
type string Credential type.
cardNumber string Card number for badge credentials.
View JSON Schema on GitHub

JSON Schema

business-api-credential-input-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-input-schema.json",
  "title": "CredentialInput",
  "description": "Request to create an access credential.",
  "type": "object",
  "required": [
    "userId",
    "type"
  ],
  "properties": {
    "userId": {
      "type": "string",
      "description": "ID of the user.",
      "example": "usr-001"
    },
    "type": {
      "type": "string",
      "description": "Credential type.",
      "enum": [
        "badge",
        "pin",
        "mobile"
      ]
    },
    "cardNumber": {
      "type": "string",
      "description": "Card number for badge credentials.",
      "example": "1234567890"
    }
  }
}