← Users operations · All schemas
Add an email address for the authenticated user — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Email |
email | string | Required within parent | Format: email |
primary | boolean | Required within parent | |
verified | boolean | Required within parent | |
visibility | JSON | Required within parent | |
visibility (anyOf 1) | string | Alternative | |
visibility (anyOf 2) | null | Alternative | |
Get a GPG key for the authenticated user — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A unique encryption key |
can_certify | boolean | Required within parent | |
can_encrypt_comms | boolean | Required within parent | |
can_encrypt_storage | boolean | Required within parent | |
can_sign | boolean | Required within parent | |
created_at | string | Required within parent | Format: date-time |
emails | array | Required within parent | |
emails[] | object | Each item | |
emails[].email | string | Optional | |
emails[].verified | boolean | Optional | |
expires_at | JSON | Required within parent | |
expires_at (anyOf 1) | string | Alternative | Format: date-time |
expires_at (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
key_id | string | Required within parent | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
primary_key_id | JSON | Required within parent | |
primary_key_id (anyOf 1) | JSON | Alternative | |
primary_key_id (anyOf 1) (anyOf 1) | integer | Alternative | |
primary_key_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
primary_key_id (anyOf 2) | null | Alternative | |
public_key | string | Required within parent | |
raw_key | JSON | Required within parent | |
raw_key (anyOf 1) | string | Alternative | |
raw_key (anyOf 2) | null | Alternative | |
revoked | boolean | Required within parent | |
subkeys | array | Required within parent | |
subkeys[] | object | Each item | |
subkeys[].can_certify | boolean | Optional | |
subkeys[].can_encrypt_comms | boolean | Optional | |
subkeys[].can_encrypt_storage | boolean | Optional | |
subkeys[].can_sign | boolean | Optional | |
subkeys[].created_at | string | Optional | |
subkeys[].emails | array | Optional | |
subkeys[].emails[] | object | Each item | |
subkeys[].emails[].email | string | Optional | |
subkeys[].emails[].verified | boolean | Optional | |
subkeys[].expires_at | JSON | Optional | |
subkeys[].expires_at (anyOf 1) | string | Alternative | |
subkeys[].expires_at (anyOf 2) | null | Alternative | |
subkeys[].id | JSON | Optional | |
subkeys[].id (anyOf 1) | integer | Alternative | Format: int64 |
subkeys[].id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
subkeys[].key_id | string | Optional | |
subkeys[].primary_key_id | JSON | Optional | |
subkeys[].primary_key_id (anyOf 1) | integer | Alternative | |
subkeys[].primary_key_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
subkeys[].public_key | string | Optional | |
subkeys[].raw_key | JSON | Optional | |
subkeys[].raw_key (anyOf 1) | string | Alternative | |
subkeys[].raw_key (anyOf 2) | null | Alternative | |
subkeys[].revoked | boolean | Optional | |
subkeys[].subkeys | array | Optional | |
subkeys[].subkeys[] | JSON | Each item | |
Get a public SSH key for the authenticated user — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Key |
created_at | string | Required within parent | Format: date-time |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
key | string | Required within parent | |
last_used | JSON | Optional | |
last_used (anyOf 1) | string | Alternative | Format: date-time |
last_used (anyOf 2) | null | Alternative | |
read_only | boolean | Required within parent | |
title | string | Required within parent | |
url | string | Required within parent | |
verified | boolean | Required within parent | |
Get a user — response body — Public User
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Public User
Additional keys: not allowed |
avatar_url | string | Required within parent | Format: uri |
bio | JSON | Required within parent | |
bio (anyOf 1) | string | Alternative | |
bio (anyOf 2) | null | Alternative | |
blog | JSON | Required within parent | |
blog (anyOf 1) | string | Alternative | |
blog (anyOf 2) | null | Alternative | |
collaborators | JSON | Optional | |
collaborators (anyOf 1) | integer | Alternative | |
collaborators (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
company | JSON | Required within parent | |
company (anyOf 1) | string | Alternative | |
company (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Format: date-time |
disk_usage | JSON | Optional | |
disk_usage (anyOf 1) | integer | Alternative | |
disk_usage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | Format: email |
email (anyOf 2) | null | Alternative | |
events_url | string | Required within parent | |
followers | JSON | Required within parent | |
followers (anyOf 1) | integer | Alternative | |
followers (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
followers_url | string | Required within parent | Format: uri |
following | JSON | Required within parent | |
following (anyOf 1) | integer | Alternative | |
following (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
following_url | string | Required within parent | |
gists_url | string | Required within parent | |
gravatar_id | JSON | Required within parent | |
gravatar_id (anyOf 1) | string | Alternative | |
gravatar_id (anyOf 2) | null | Alternative | |
hireable | JSON | Required within parent | |
hireable (anyOf 1) | boolean | Alternative | |
hireable (anyOf 2) | null | Alternative | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
location | JSON | Required within parent | |
location (anyOf 1) | string | Alternative | |
location (anyOf 2) | null | Alternative | |
login | string | Required within parent | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | |
notification_email | JSON | Optional | |
notification_email (anyOf 1) | string | Alternative | Format: email |
notification_email (anyOf 2) | null | Alternative | |
organizations_url | string | Required within parent | Format: uri |
owned_private_repos | JSON | Optional | |
owned_private_repos (anyOf 1) | integer | Alternative | |
owned_private_repos (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
plan | object | Optional | |
plan.collaborators | JSON | Required within parent | |
plan.collaborators (anyOf 1) | integer | Alternative | |
plan.collaborators (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
plan.name | string | Required within parent | |
plan.private_repos | JSON | Required within parent | |
plan.private_repos (anyOf 1) | integer | Alternative | |
plan.private_repos (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
plan.space | JSON | Required within parent | |
plan.space (anyOf 1) | integer | Alternative | |
plan.space (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
private_gists | JSON | Optional | |
private_gists (anyOf 1) | integer | Alternative | |
private_gists (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
public_gists | JSON | Required within parent | |
public_gists (anyOf 1) | integer | Alternative | |
public_gists (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
public_repos | JSON | Required within parent | |
public_repos (anyOf 1) | integer | Alternative | |
public_repos (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
received_events_url | string | Required within parent | Format: uri |
repos_url | string | Required within parent | Format: uri |
site_admin | boolean | Required within parent | |
starred_url | string | Required within parent | |
subscriptions_url | string | Required within parent | Format: uri |
total_private_repos | JSON | Optional | |
total_private_repos (anyOf 1) | integer | Alternative | |
total_private_repos (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
twitter_username | JSON | Optional | |
twitter_username (anyOf 1) | string | Alternative | |
twitter_username (anyOf 2) | null | Alternative | |
type | string | Required within parent | |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
user_view_type | string | Optional | |
Get an SSH signing key for the authenticated user — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A public SSH key used to sign Git commits |
created_at | string | Required within parent | Format: date-time |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
key | string | Required within parent | |
title | string | Required within parent | |
Get contextual information for a user — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Hovercard |
contexts | array | Required within parent | |
contexts[] | object | Each item | |
contexts[].message | string | Required within parent | |
contexts[].octicon | string | Required within parent | |
List public keys for a user — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Key Simple |
created_at | string | Optional | Format: date-time |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
key | string | Required within parent | |
last_used | JSON | Optional | |
last_used (anyOf 1) | string | Alternative | Format: date-time |
last_used (anyOf 2) | null | Alternative | |
List social accounts for a user — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Social media account |
provider | string | Required within parent | |
url | string | Required within parent | |
List users — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A GitHub user. |
avatar_url | string | Required within parent | Format: uri |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | null | Alternative | |
events_url | string | Required within parent | |
followers_url | string | Required within parent | Format: uri |
following_url | string | Required within parent | |
gists_url | string | Required within parent | |
gravatar_id | JSON | Required within parent | |
gravatar_id (anyOf 1) | string | Alternative | |
gravatar_id (anyOf 2) | null | Alternative | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
login | string | Required within parent | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | |
organizations_url | string | Required within parent | Format: uri |
received_events_url | string | Required within parent | Format: uri |
repos_url | string | Required within parent | Format: uri |
site_admin | boolean | Required within parent | |
starred_at | string | Optional | |
starred_url | string | Required within parent | |
subscriptions_url | string | Required within parent | Format: uri |
type | string | Required within parent | |
url | string | Required within parent | Format: uri |
user_view_type | string | Optional | |
Update the authenticated user — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Private User |
avatar_url | string | Required within parent | Format: uri |
bio | JSON | Required within parent | |
bio (anyOf 1) | string | Alternative | |
bio (anyOf 2) | null | Alternative | |
blog | JSON | Required within parent | |
blog (anyOf 1) | string | Alternative | |
blog (anyOf 2) | null | Alternative | |
business_plus | boolean | Optional | |
collaborators | JSON | Required within parent | |
collaborators (anyOf 1) | integer | Alternative | |
collaborators (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
company | JSON | Required within parent | |
company (anyOf 1) | string | Alternative | |
company (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Format: date-time |
disk_usage | JSON | Required within parent | |
disk_usage (anyOf 1) | integer | Alternative | |
disk_usage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | Format: email |
email (anyOf 2) | null | Alternative | |
events_url | string | Required within parent | |
followers | JSON | Required within parent | |
followers (anyOf 1) | integer | Alternative | |
followers (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
followers_url | string | Required within parent | Format: uri |
following | JSON | Required within parent | |
following (anyOf 1) | integer | Alternative | |
following (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
following_url | string | Required within parent | |
gists_url | string | Required within parent | |
gravatar_id | JSON | Required within parent | |
gravatar_id (anyOf 1) | string | Alternative | |
gravatar_id (anyOf 2) | null | Alternative | |
hireable | JSON | Required within parent | |
hireable (anyOf 1) | boolean | Alternative | |
hireable (anyOf 2) | null | Alternative | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ldap_dn | string | Optional | |
location | JSON | Required within parent | |
location (anyOf 1) | string | Alternative | |
location (anyOf 2) | null | Alternative | |
login | string | Required within parent | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | |
notification_email | JSON | Optional | |
notification_email (anyOf 1) | string | Alternative | Format: email |
notification_email (anyOf 2) | null | Alternative | |
organizations_url | string | Required within parent | Format: uri |
owned_private_repos | JSON | Required within parent | |
owned_private_repos (anyOf 1) | integer | Alternative | |
owned_private_repos (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
plan | object | Optional | |
plan.collaborators | JSON | Required within parent | |
plan.collaborators (anyOf 1) | integer | Alternative | |
plan.collaborators (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
plan.name | string | Required within parent | |
plan.private_repos | JSON | Required within parent | |
plan.private_repos (anyOf 1) | integer | Alternative | |
plan.private_repos (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
plan.space | JSON | Required within parent | |
plan.space (anyOf 1) | integer | Alternative | |
plan.space (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
private_gists | JSON | Required within parent | |
private_gists (anyOf 1) | integer | Alternative | |
private_gists (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
public_gists | JSON | Required within parent | |
public_gists (anyOf 1) | integer | Alternative | |
public_gists (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
public_repos | JSON | Required within parent | |
public_repos (anyOf 1) | integer | Alternative | |
public_repos (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
received_events_url | string | Required within parent | Format: uri |
repos_url | string | Required within parent | Format: uri |
site_admin | boolean | Required within parent | |
starred_url | string | Required within parent | |
subscriptions_url | string | Required within parent | Format: uri |
total_private_repos | JSON | Required within parent | |
total_private_repos (anyOf 1) | integer | Alternative | |
total_private_repos (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
twitter_username | JSON | Optional | |
twitter_username (anyOf 1) | string | Alternative | |
twitter_username (anyOf 2) | null | Alternative | |
two_factor_authentication | boolean | Required within parent | |
type | string | Required within parent | |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
user_view_type | string | Optional | |
