user

TravelUnited StatesHospitalityHotelsBookingFranchisingDistributionLoyaltyGDS

Properties

Name	Type	Description
id	integer	Unique identifier for the user.
username	string	Login name for the user.
name	string	Display name for the user.
first_name	string	First name for the user.
last_name	string	Last name for the user.
email	string	The email address for the user.
url	string	URL of the user.
description	string	Description of the user.
link	string	Author URL of the user.
locale	string	Locale for the user.
nickname	string	The nickname for the user.
slug	string	An alphanumeric identifier for the user.
registered_date	string	Registration date for the user.
roles	array	Roles assigned to the user.
password	string	Password for the user (never included).
capabilities	object	All capabilities assigned to the user.
extra_capabilities	object	Any extra capabilities assigned to the user.
meta	object	Meta fields.
acf	object	ACF field data

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "user",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier for the user.",
      "type": "integer",
      "context": [
        "embed",
        "view",
        "edit"
      ],
      "readonly": true
    },
    "username": {
      "description": "Login name for the user.",
      "type": "string",
      "context": [
        "edit"
      ],
      "required": true
    },
    "name": {
      "description": "Display name for the user.",
      "type": "string",
      "context": [
        "embed",
        "view",
        "edit"
      ]
    },
    "first_name": {
      "description": "First name for the user.",
      "type": "string",
      "context": [
        "edit"
      ]
    },
    "last_name": {
      "description": "Last name for the user.",
      "type": "string",
      "context": [
        "edit"
      ]
    },
    "email": {
      "description": "The email address for the user.",
      "type": "string",
      "format": "email",
      "context": [
        "edit"
      ],
      "required": true
    },
    "url": {
      "description": "URL of the user.",
      "type": "string",
      "format": "uri",
      "context": [
        "embed",
        "view",
        "edit"
      ]
    },
    "description": {
      "description": "Description of the user.",
      "type": "string",
      "context": [
        "embed",
        "view",
        "edit"
      ]
    },
    "link": {
      "description": "Author URL of the user.",
      "type": "string",
      "format": "uri",
      "context": [
        "embed",
        "view",
        "edit"
      ],
      "readonly": true
    },
    "locale": {
      "description": "Locale for the user.",
      "type": "string",
      "enum": [
        "",
        "en_US",
        "es_ES"
      ],
      "context": [
        "edit"
      ]
    },
    "nickname": {
      "description": "The nickname for the user.",
      "type": "string",
      "context": [
        "edit"
      ]
    },
    "slug": {
      "description": "An alphanumeric identifier for the user.",
      "type": "string",
      "context": [
        "embed",
        "view",
        "edit"
      ]
    },
    "registered_date": {
      "description": "Registration date for the user.",
      "type": "string",
      "format": "date-time",
      "context": [
        "edit"
      ],
      "readonly": true
    },
    "roles": {
      "description": "Roles assigned to the user.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "context": [
        "edit"
      ]
    },
    "password": {
      "description": "Password for the user (never included).",
      "type": "string",
      "context": [],
      "required": true
    },
    "capabilities": {
      "description": "All capabilities assigned to the user.",
      "type": "object",
      "context": [
        "edit"
      ],
      "readonly": true
    },
    "extra_capabilities": {
      "description": "Any extra capabilities assigned to the user.",
      "type": "object",
      "context": [
        "edit"
      ],
      "readonly": true
    },
    "meta": {
      "description": "Meta fields.",
      "type": "object",
      "context": [
        "view",
        "edit"
      ],
      "properties": {
        "persisted_preferences": {
          "type": "object",
          "title": "",
          "description": "",
          "default": [],
          "context": [
            "edit"
          ],
          "properties": {
            "_modified": {
              "description": "The date and time the preferences were updated.",
              "type": "string",
              "format": "date-time",
              "readonly": false
            }
          },
          "additionalProperties": true
        }
      }
    },
    "acf": {
      "description": "ACF field data",
      "type": "object",
      "properties": []
    }
  }
}