ADT · Schema

AccessCode

An access code for a security system.

Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Properties

Name	Type	Description
id	string	Unique identifier of the access code.
name	string	Display name for the access code.
type	string	Type of access code.
expiresAt	string	Expiration timestamp for temporary codes.
permissions	array	List of permissions granted by this code.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-schema/platform-api-access-code-schema.json",
  "title": "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": "string",
      "format": "date-time",
      "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"
      }
    }
  }
}