ADT · JSON Structure

Business Api User Structure

A user with access to a business site.

Type: object Properties: 4
Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

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

Properties

id name email role

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-user-structure.json",
  "name": "User",
  "description": "A user with access to a business site.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique user ID.",
      "example": "usr-001"
    },
    "name": {
      "type": "string",
      "description": "Full name of the user.",
      "example": "Jane Smith"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address.",
      "example": "jsmith@example.com"
    },
    "role": {
      "type": "string",
      "description": "User role.",
      "enum": [
        "admin",
        "manager",
        "employee",
        "contractor"
      ],
      "example": "employee"
    }
  }
}