ADT · JSON Structure

Platform Api Access Code Structure

An access code for a security system.

Type: object Properties: 5
Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

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

Properties

id name type expiresAt permissions

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/platform-api-access-code-structure.json",
  "name": "AccessCode",
  "description": "An access code for a security system.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the access code.",
      "example": "code-001"
    },
    "name": {
      "type": "string",
      "description": "Display name for the access code.",
      "example": "Master Code"
    },
    "type": {
      "type": "string",
      "description": "Type of access code.",
      "enum": [
        "master",
        "standard",
        "temporary",
        "duress"
      ],
      "example": "standard"
    },
    "expiresAt": {
      "type": "datetime",
      "description": "Expiration timestamp for temporary codes.",
      "example": "2025-03-20T23:59:59Z"
    },
    "permissions": {
      "type": "array",
      "description": "List of permissions granted by this code.",
      "items": {
        "type": "string"
      }
    }
  }
}