ADT · JSON Structure

Business Api Credential Input Structure

Request to create an access credential.

Type: object Properties: 3 Required: 2
Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

CredentialInput is a JSON Structure definition published by ADT, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

userId type cardNumber

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-input-structure.json",
  "name": "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"
    }
  }
}