Docupilot · Schema

PatchedUser

PatchedUser schema from Docupilot accounts API

Document GenerationPDF GenerationDocument AutomationTemplate EngineeSignatureWorkflow Automation

Properties

Name	Type	Description
id	integer
guid	string	globally unique identifier for user
first_name	string
last_name	string
email	string
timezone	string
locale	string
is_active	boolean	Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
locale_display_name	string
theme	string
is_mfa_enabled	boolean
organization	object
role	string
workspaces	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PatchedUser",
  "description": "PatchedUser schema from Docupilot accounts API",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "guid": {
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "description": "globally unique identifier for user"
    },
    "first_name": {
      "type": "string",
      "maxLength": 50
    },
    "last_name": {
      "type": "string",
      "maxLength": 50
    },
    "email": {
      "type": "string",
      "format": "email",
      "readOnly": true
    },
    "timezone": {
      "enum": [
        "Pacific/Midway",
        "America/Adak",
        "Pacific/Honolulu",
        "Pacific/Marquesas",
        "America/Anchorage",
        "America/Tijuana",
        "America/Los_Angeles",
        "America/Phoenix",
        "America/Chihuahua",
        "America/Denver",
        "America/Belize",
        "America/Chicago",
        "Pacific/Easter",
        "America/Mexico_City",
        "America/Regina",
        "America/Bogota",
        "America/Cancun",
        "America/New_York",
        "America/Port-au-Prince",
        "America/Havana",
        "America/Indiana/Indianapolis",
        "America/Asuncion",
        "America/Halifax",
        "America/Caracas",
        "America/Cuiaba",
        "America/Manaus",
        "America/Santiago",
        "America/Grand_Turk",
        "America/St_Johns",
        "America/Fortaleza",
        "America/Sao_Paulo",
        "America/Cayenne",
        "America/Buenos_Aires",
        "America/Godthab",
        "America/Montevideo",
        "America/Miquelon",
        "America/Bahia",
        "America/Noronha",
        "Atlantic/Azores",
        "Atlantic/Cape_Verde",
        "UTC",
        "Africa/Casablanca",
        "Europe/London",
        "Africa/Monrovia",
        "Europe/Amsterdam",
        "Europe/Belgrade",
        "Europe/Brussels",
        "Europe/Warsaw",
        "Africa/Algiers",
        "Africa/Windhoek",
        "Asia/Amman",
        "Europe/Athens",
        "Asia/Beirut",
        "Africa/Cairo",
        "Asia/Damascus",
        "Asia/Gaza",
        "Africa/Harare",
        "Europe/Helsinki",
        "Asia/Jerusalem",
        "Europe/Kaliningrad",
        "Africa/Tripoli",
        "Asia/Baghdad",
        "Asia/Istanbul",
        "Asia/Kuwait",
        "Europe/Minsk",
        "Europe/Moscow",
        "Africa/Nairobi",
        "Asia/Tehran",
        "Asia/Muscat",
        "Europe/Astrakhan",
        "Asia/Baku",
        "Europe/Samara",
        "Indian/Mauritius",
        "Asia/Tbilisi",
        "Asia/Yerevan",
        "Asia/Kabul",
        "Asia/Tashkent",
        "Asia/Yekaterinburg",
        "Asia/Karachi",
        "Asia/Kolkata",
        "Asia/Colombo",
        "Asia/Katmandu",
        "Asia/Almaty",
        "Asia/Dhaka",
        "Asia/Rangoon",
        "Asia/Novosibirsk",
        "Asia/Bangkok",
        "Asia/Barnaul",
        "Asia/Hovd",
        "Asia/Krasnoyarsk",
        "Asia/Tomsk",
        "Asia/Chongqing",
        "Asia/Irkutsk",
        "Asia/Kuala_Lumpur",
        "Australia/Perth",
        "Asia/Taipei",
        "Asia/Ulaanbaatar",
        "Asia/Pyongyang",
        "Australia/Eucla",
        "Asia/Chita",
        "Asia/Tokyo",
        "Asia/Seoul",
        "Asia/Yakutsk",
        "Australia/Adelaide",
        "Australia/Darwin",
        "Australia/Brisbane",
        "Australia/Canberra",
        "Pacific/Guam",
        "Australia/Hobart",
        "Asia/Vladivostok",
        "Australia/Lord_Howe",
        "Pacific/Bougainville",
        "Asia/Srednekolymsk",
        "Asia/Magadan",
        "Pacific/Norfolk",
        "Asia/Sakhalin",
        "Pacific/Guadalcanal",
        "Asia/Anadyr",
        "Pacific/Auckland",
        "Pacific/Fiji",
        "Pacific/Chatham",
        "Pacific/Tongatapu",
        "Pacific/Apia",
        "Pacific/Kiritimati"
      ],
      "type": "string"
    },
    "locale": {
      "enum": [
        "en",
        "nl",
        "fr",
        "de",
        "es",
        "ar",
        "he",
        null
      ],
      "type": "string",
      "nullable": true
    },
    "is_active": {
      "type": "boolean",
      "readOnly": true,
      "title": "Active",
      "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts."
    },
    "locale_display_name": {
      "type": "string",
      "readOnly": true
    },
    "theme": {
      "enum": [
        "light",
        "dark",
        "system"
      ],
      "type": "string"
    },
    "is_mfa_enabled": {
      "type": "boolean",
      "readOnly": true
    },
    "organization": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserOrganization"
        }
      ],
      "readOnly": true
    },
    "role": {
      "enum": [
        "owner",
        "admin",
        "member"
      ],
      "type": "string",
      "readOnly": true
    },
    "workspaces": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Workspace"
      },
      "readOnly": true
    }
  }
}