GitHub · Schema
GitHub User
A GitHub user account representing an individual, organization, or bot that interacts with repositories, issues, and other resources.
CodePipelinesPlatformSoftware DevelopmentSource ControlT1
Properties
| Name | Type | Description |
|---|---|---|
| login | string | The username of the user. |
| id | integer | The unique identifier for the user. |
| node_id | string | The GraphQL node ID for the user. |
| avatar_url | string | URL to the user's avatar image. |
| gravatar_id | stringnull | The Gravatar ID associated with the user's email. |
| url | string | The API URL for the user. |
| html_url | string | URL to the user's GitHub profile. |
| followers_url | string | API URL for the user's followers. |
| following_url | string | API URL template for who the user is following. |
| gists_url | string | API URL template for the user's gists. |
| repos_url | string | API URL for the user's repositories. |
| type | string | The type of GitHub account. |
| site_admin | boolean | Whether the user is a GitHub site administrator. |
| name | stringnull | The display name of the user. |
| company | stringnull | The company the user is associated with. |
| blog | stringnull | The user's blog or website URL. |
| location | stringnull | The user's location. |
| stringnull | The user's publicly visible email address. | |
| hireable | booleannull | Whether the user has indicated they are available for hire. |
| bio | stringnull | The user's biography. |
| twitter_username | stringnull | The user's Twitter/X username. |
| public_repos | integer | The number of public repositories the user owns. |
| public_gists | integer | The number of public gists the user has created. |
| followers | integer | The number of followers the user has. |
| following | integer | The number of users the user is following. |
| created_at | string | The date and time the user account was created. |
| updated_at | string | The date and time the user account was last updated. |
| two_factor_authentication | boolean | Whether the user has two-factor authentication enabled. Only visible for the authenticated user. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/schemas/github/user.json",
"title": "GitHub User",
"description": "A GitHub user account representing an individual, organization, or bot that interacts with repositories, issues, and other resources.",
"type": "object",
"required": ["login", "id", "type"],
"properties": {
"login": {
"type": "string",
"description": "The username of the user.",
"pattern": "^[a-zA-Z0-9](?:[a-zA-Z0-9]|-(?=[a-zA-Z0-9])){0,38}$"
},
"id": {
"type": "integer",
"description": "The unique identifier for the user."
},
"node_id": {
"type": "string",
"description": "The GraphQL node ID for the user."
},
"avatar_url": {
"type": "string",
"format": "uri",
"description": "URL to the user's avatar image."
},
"gravatar_id": {
"type": ["string", "null"],
"description": "The Gravatar ID associated with the user's email."
},
"url": {
"type": "string",
"format": "uri",
"description": "The API URL for the user."
},
"html_url": {
"type": "string",
"format": "uri",
"description": "URL to the user's GitHub profile."
},
"followers_url": {
"type": "string",
"format": "uri",
"description": "API URL for the user's followers."
},
"following_url": {
"type": "string",
"description": "API URL template for who the user is following."
},
"gists_url": {
"type": "string",
"description": "API URL template for the user's gists."
},
"repos_url": {
"type": "string",
"format": "uri",
"description": "API URL for the user's repositories."
},
"type": {
"type": "string",
"enum": ["User", "Organization", "Bot"],
"description": "The type of GitHub account."
},
"site_admin": {
"type": "boolean",
"description": "Whether the user is a GitHub site administrator."
},
"name": {
"type": ["string", "null"],
"description": "The display name of the user."
},
"company": {
"type": ["string", "null"],
"description": "The company the user is associated with."
},
"blog": {
"type": ["string", "null"],
"description": "The user's blog or website URL."
},
"location": {
"type": ["string", "null"],
"description": "The user's location."
},
"email": {
"type": ["string", "null"],
"format": "email",
"description": "The user's publicly visible email address."
},
"hireable": {
"type": ["boolean", "null"],
"description": "Whether the user has indicated they are available for hire."
},
"bio": {
"type": ["string", "null"],
"description": "The user's biography.",
"maxLength": 160
},
"twitter_username": {
"type": ["string", "null"],
"description": "The user's Twitter/X username."
},
"public_repos": {
"type": "integer",
"minimum": 0,
"description": "The number of public repositories the user owns."
},
"public_gists": {
"type": "integer",
"minimum": 0,
"description": "The number of public gists the user has created."
},
"followers": {
"type": "integer",
"minimum": 0,
"description": "The number of followers the user has."
},
"following": {
"type": "integer",
"minimum": 0,
"description": "The number of users the user is following."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the user account was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the user account was last updated."
},
"two_factor_authentication": {
"type": "boolean",
"description": "Whether the user has two-factor authentication enabled. Only visible for the authenticated user."
}
}
}