GitHub · Schema

user-name-response

user-name-response from GitHub API

CodePipelinesPlatformSoftware DevelopmentSource ControlT1

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

github-scim-user-name-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-scim-user-name-response-schema.json",
  "title": "user-name-response",
  "description": "user-name-response from GitHub API",
  "type": "object",
  "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"
    }
  }
}