Acquia · Schema

User

The response for a user object.

ContentExperience

Properties

Name Type Description
id integer The internal database ID (uid) of the user.
uuid string The UUID for the user.
name string The user name.
first_name string The first name of the user.
last_name string The last name of the user.
last_login_at string The date/time of the last login for the user.
created_at string The date/time when the user was created.
mail string The e-mail address of the user.
phone object The telephone numbers for the user.
job_title string The job title of the user.
job_function string The job function of the user.
company string The company of the user.
country string The country of the user.
state string The state of the user, if in the United States.
timezone string The timezone of the user.
picture_url string The user's picture url.
features array The various feature flags for the user.
flags object
metadata object Metadata related to the user.
_links object
View JSON Schema on GitHub

JSON Schema

acquia-cloud-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/json-schema/acquia-cloud-user-schema.json",
  "title": "User",
  "description": "The response for a user object.",
  "type": "object",
  "properties": {
    "id": {
      "deprecated": true,
      "type": "integer",
      "description": "The internal database ID (uid) of the user."
    },
    "uuid": {
      "type": "string",
      "format": "uuid",
      "description": "The UUID for the user."
    },
    "name": {
      "type": "string",
      "description": "The user name."
    },
    "first_name": {
      "type": "string",
      "description": "The first name of the user."
    },
    "last_name": {
      "type": "string",
      "description": "The last name of the user."
    },
    "last_login_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date/time of the last login for the user.",
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date/time when the user was created."
    },
    "mail": {
      "type": "string",
      "format": "email",
      "description": "The e-mail address of the user."
    },
    "phone": {
      "type": "object",
      "description": "The telephone numbers for the user.",
      "properties": {
        "office": {
          "type": "string",
          "description": "The office telephone number for the user.",
          "nullable": true
        },
        "tfa": {
          "type": "string",
          "description": "The tfa backup telephone number for the user.",
          "nullable": true
        }
      }
    },
    "job_title": {
      "type": "string",
      "description": "The job title of the user."
    },
    "job_function": {
      "type": "string",
      "description": "The job function of the user.",
      "enum": [
        "--",
        "Business Executive",
        "IT Executive",
        "IT Architect or IT Operations",
        "Product or Digital Marketing",
        "Website Design or Development"
      ]
    },
    "company": {
      "type": "string",
      "description": "The company of the user."
    },
    "country": {
      "type": "string",
      "description": "The country of the user.",
      "enum": [
        "--",
        "United States",
        "Afghanistan",
        "Albania",
        "Algeria",
        "American Samoa",
        "Andorra",
        "Angola",
        "Anguilla",
        "Antigua and Barbuda",
        "Argentina",
        "Armenia",
        "Ascension Island",
        "Australia",
        "Austria",
        "Azerbaijan",
        "Bahamas",
        "Bahrain",
        "Bangladesh",
        "Barbados",
        "Belarus",
        "Belgium",
        "Belize",
        "Benin",
        "Bermuda",
        "Bhutan",
        "Bolivia",
        "Bosnia and Herzegovina",
        "Botswana",
        "Brazil",
        "British Indian Ocean Territory",
        "Brunei Darussalam",
        "Bulgaria",
        "Burkina Faso",
        "Burundi",
        "Cambodia",
        "Cameroon",
        "Canada",
        "Cape Verde",
        "Cayman Islands",
        "Central African Republic",
        "Chad",
        "Chile",
        "China",
        "Colombia",
        "Comoros",
        "Congo",
        "Cook Islands",
        "Costa Rica",
        "Cote D Ivoire",
        "Croatia",
        "Cuba",
        "Cyprus",
        "Czech Republic",
        "Denmark",
        "Djibouti",
        "Dominica",
        "Dominican Republic",
        "Ecuador",
        "Egypt",
        "El Salvador",
        "Equatorial Guinea",
        "Eritrea",
        "Estonia",
        "Ethiopia",
        "Falkland Islands",
        "Faroe Islands",
        "Federated States of Micronesia",
        "Fiji",
        "Finland",
        "France",
        "French Guiana",
        "French Polynesia",
        "Gabon",
        "Georgia",
        "Germany",
        "Ghana",
        "Greece",
        "Greenland",
        "Grenada",
        "Guadeloupe",
        "Guatemala",
        "Guam",
        "Guinea",
        "Guinea Bissau",
        "Guyana",
        "Haiti",
        "Holy See (Vatican City)",
        "Honduras",
        "Hong Kong",
        "Hungary",
        "Iceland",
        "India",
        "Indonesia",
        "Iran",
        "Ireland",
        "Isle of Man",
        "Israel",
        "Italy",
        "Jamaica",
        "Japan",
        "Jordan",
        "Kazakhstan",
        "Kenya",
        "Kiribati",
        "Korea",
        "Kuwait",
        "Kyrgyzstan",
        "Laos",
        "Latvia",
        "Lebanon",
        "Lesotho",
        "Liberia",
        "Libya",
        "Liechtenstein",
        "Lithuania",
        "Luxembourg",
        "Macau",
        "Macedonia",
        "Madagascar",
        "Malawi",
        "Malaysia",
        "Maldives",
        "Mali",
        "Malta",
        "Marshall Islands",
        "Martinique",
        "Mauritius",
        "Mayotte",
        "Mexico",
        "Moldova",
        "Monaco",
        "Mongolia",
        "Montenegro",
        "Montserrat",
        "Morocco",
        "Mozambique",
        "Myanmar",
        "Namibia",
        "Nauru",
        "Nepal",
        "Netherlands",
        "Netherlands Antilles",
        "New Caledonia",
        "New Zealand",
        "Nicaragua",
        "Niger",
        "Nigeria",
        "Niue",
        "Norfolk Island",
        "Northern Mariana Islands",
        "Norway",
        "Oman",
        "Pakistan",
        "Palau",
        "Palestine",
        "Panama",
        "Papua New Guinea",
        "Paraguay",
        "Peru",
        "Philippines",
        "Pitcairn",
        "Poland",
        "Portugal",
        "Puerto Rico",
        "Qatar",
        "Reunion",
        "Romania",
        "Russian Federation",
        "Rwanda",
        "Saint Vincent and the Grenadines",
        "San Marino",
        "Sao Tome and Principe",
        "Saudi Arabia",
        "Senegal",
        "Serbia",
        "Seychelles",
        "Sierra Leone",
        "Singapore",
        "Slovakia",
        "Slovenia",
        "Solomon Islands",
        "Somalia",
        "South Africa",
        "South Georgia",
        "Spain",
        "Sri Lanka",
        "St. Kitts and Nevis",
        "St. Lucia",
        "St. Pierre and Miquelon",
        "Sudan",
        "Suriname",
        "Swaziland",
        "Sweden",
        "Switzerland",
        "Syrian Arab Republic",
        "Taiwan",
        "Tajikistan",
        "Tanzania",
        "Thailand",
        "The Gambia",
        "Togo",
        "Tokelau",
        "Tonga",
        "Trinidad and Tobago",
        "Tunisia",
        "Turkey",
        "Turkmenistan",
        "Turks and Caicos Islands",
        "Tuvalu",
        "Uganda",
        "Ukraine",
        "United Arab Emirates",
        "United Kingdom",
        "Uruguay",
        "Uzbekistan",
        "Vanuatu",
        "Venezuela",
        "Viet Nam",
        "Virgin Islands",
        "Western Samoa",
        "Yemen",
        "Yugoslavia",
        "Zaire",
        "Zambia",
        "Zimbabwe"
      ]
    },
    "state": {
      "type": "string",
      "description": "The state of the user, if in the United States.",
      "enum": [
        "Alabama",
        "Alaska",
        "American Samoa",
        "Arizona",
        "Arkansas",
        "California",
        "Colorado",
        "Connecticut",
        "Delaware",
        "District of Columbia",
        "Florida",
        "Georgia",
        "Hawaii",
        "Idaho",
        "Illinois",
        "Indiana",
        "Iowa",
        "Kansas",
        "Kentucky",
        "Louisiana",
        "Maine",
        "Maryland",
        "Massachusetts",
        "Michigan",
        "Minnesota",
        "Mississippi",
        "Missouri",
        "Montana",
        "Nebraska",
        "Nevada",
        "New Hampshire",
        "New Jersey",
        "New Mexico",
        "New York",
        "North Carolina",
        "North Dakota",
        "Northern Mariana Islands",
        "Ohio",
        "Oklahoma",
        "Oregon",
        "Pennsylvania",
        "Rhode Island",
        "South Carolina",
        "South Dakota",
        "Tennessee",
        "Texas",
        "U.S. Virgin Islands",
        "Utah",
        "Vermont",
        "Virginia",
        "Washington",
        "West Virginia",
        "Wisconsin",
        "Wyoming"
      ]
    },
    "timezone": {
      "type": "string",
      "description": "The timezone of the user."
    },
    "picture_url": {
      "type": "string",
      "format": "uri",
      "description": "The user's picture url."
    },
    "features": {
      "deprecated": true,
      "type": "array",
      "description": "The various feature flags for the user.",
      "items": {
        "type": "string",
        "enum": [
          "ci-pipelines",
          "n3-disabled",
          "n3-hybrid-mode",
          "on-demand-environments",
          "php7",
          "php71",
          "platform"
        ]
      }
    },
    "flags": {
      "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_user-flags"
    },
    "metadata": {
      "deprecated": true,
      "type": "object",
      "description": "Metadata related to the user.",
      "properties": {
        "applications": {
          "type": "object",
          "description": "An array of application metadata for the user.",
          "properties": {
            "recent": {
              "type": "array",
              "description": "An array containing recent visited application information.",
              "items": {
                "type": "object",
                "properties": {
                  "uuid": {
                    "type": "string",
                    "format": "uuid",
                    "description": "The application UUID."
                  },
                  "recent_at": {
                    "type": "string",
                    "format": "date-time",
                    "description": "The date-time when the application was accessed."
                  }
                }
              }
            },
            "starred": {
              "type": "array",
              "description": "An array containing starred application UUIDs.",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "_links": {
      "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_links"
    }
  },
  "required": [
    "uuid",
    "name",
    "first_name",
    "last_name",
    "last_login_at",
    "created_at",
    "mail",
    "phone",
    "job_title",
    "job_function",
    "company",
    "country",
    "timezone",
    "picture_url",
    "flags",
    "_links"
  ]
}