Github User Structure
A GitHub user account representing an individual, organization, or bot that interacts with repositories, issues, and other resources.
Type: object
Properties: 28
Required: 3
CodePipelinesPlatformSoftware DevelopmentSource ControlT1
GitHub User is a JSON Structure definition published by GitHub, describing 28 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://github.com/schemas/github/user.json",
"name": "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": "int32",
"description": "The unique identifier for the user."
},
"node_id": {
"type": "string",
"description": "The GraphQL node ID for the user."
},
"avatar_url": {
"type": "uri",
"description": "URL to the user's avatar image."
},
"gravatar_id": {
"type": "string",
"description": "The Gravatar ID associated with the user's email."
},
"url": {
"type": "uri",
"description": "The API URL for the user."
},
"html_url": {
"type": "uri",
"description": "URL to the user's GitHub profile."
},
"followers_url": {
"type": "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": "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",
"description": "The display name of the user."
},
"company": {
"type": "string",
"description": "The company the user is associated with."
},
"blog": {
"type": "string",
"description": "The user's blog or website URL."
},
"location": {
"type": "string",
"description": "The user's location."
},
"email": {
"type": "string",
"format": "email",
"description": "The user's publicly visible email address."
},
"hireable": {
"type": "boolean",
"description": "Whether the user has indicated they are available for hire."
},
"bio": {
"type": "string",
"description": "The user's biography.",
"maxLength": 160
},
"twitter_username": {
"type": "string",
"description": "The user's Twitter/X username."
},
"public_repos": {
"type": "int32",
"minimum": 0,
"description": "The number of public repositories the user owns."
},
"public_gists": {
"type": "int32",
"minimum": 0,
"description": "The number of public gists the user has created."
},
"followers": {
"type": "int32",
"minimum": 0,
"description": "The number of followers the user has."
},
"following": {
"type": "int32",
"minimum": 0,
"description": "The number of users the user is following."
},
"created_at": {
"type": "datetime",
"description": "The date and time the user account was created."
},
"updated_at": {
"type": "datetime",
"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."
}
}
}