user-name

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
formatted	string	The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
familyName	string	The family name of the user.
givenName	string	The given name of the user.
middleName	string	The middle name(s) of the user.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/user-name",
  "title": "user-name",
  "type": "object",
  "required": [
    "familyName",
    "givenName"
  ],
  "properties": {
    "formatted": {
      "type": "string",
      "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.",
      "example": "Ms. Mona Lisa Octocat"
    },
    "familyName": {
      "type": "string",
      "description": "The family name of the user.",
      "example": "Octocat"
    },
    "givenName": {
      "type": "string",
      "description": "The given name of the user.",
      "example": "Mona"
    },
    "middleName": {
      "type": "string",
      "description": "The middle name(s) of the user.",
      "example": "Lisa"
    }
  }
}