User
An individual user.
Attributes
Minimal Representation
Included when the resource is returned as part of another resource.
Name | Type | Description |
---|---|---|
id | Integer | Value uniquely identifying the user. |
login | String | Login set on Github. |
name | String | Name set on GitHub. |
vcs_type | Unknown | The user's vcs_type. |
ro_mode | Unknown | The user's ro_mode. |
Standard Representation
Included when the resource is the main response of a request, or is eager loaded.
Name | Type | Description |
---|---|---|
id | Integer | Value uniquely identifying the user. |
login | String | Login set on Github. |
name | String | Name set on GitHub. |
github_id | Integer | Id set on GitHub. |
vcs_id | Unknown | The user's vcs_id. |
vcs_type | Unknown | The user's vcs_type. |
avatar_url | String | Avatar URL set on GitHub. |
education | Boolean | Whether or not the user has an education account. |
allow_migration | Unknown | The user's allow_migration. |
allowance | Unknown | The user's allowance. |
ro_mode | Unknown | The user's ro_mode. |
custom_keys | Unknown | The user's custom_keys. |
trial_allowed | Unknown | The user's trial_allowed. |
Unknown | The user's email. | |
is_syncing | Boolean | Whether or not the user is currently being synced with Github. |
synced_at | String | The last time the user was synced with GitHub. |
recently_signed_up | Unknown | The user's recently_signed_up. |
secure_user_hash | Unknown | The user's secure_user_hash. |
ro_mode | Unknown | The user's ro_mode. |
confirmed_at | Unknown | The user's confirmed_at. |
custom_keys | Unknown | The user's custom_keys. |
Additional Attributes
Name | Type | Description |
---|---|---|
repositories | [Repository] | Repositories belonging to this user. |
installation | Installation | Installation belonging to the user. |
trial_allowed | Unknown | The user's trial_allowed. |
emails | Unknown | The user's emails. |
collaborator | Unknown | The user's collaborator. |
Actions
Find
This will return information about an individual user.
GET
/user/{user.id}
Template Variable | Type | Description |
---|---|---|
user.id | Integer | Value uniquely identifying the user. |
Query Parameter | Type | Description |
---|---|---|
include | [String] | List of attributes to eager load. |
Example:GET /user/invalid
Sync
This triggers a sync on a user's account with their GitHub account.
POST
/user/{user.id}/sync
Template Variable | Type | Description |
---|---|---|
user.id | Integer | Value uniquely identifying the user. |
Example:POST /user/invalid/sync
Current
This will return information about the current user.
GET
/user
Query Parameter | Type | Description |
---|---|---|
include | [String] | List of attributes to eager load. |
Example:GET /user
Update
Document resources/user/actions/update
not found.
PATCH
/user
Accepted Parameter | Type | Description |
---|---|---|
user.utm_params | Unknown | Documentation missing. |
Example:PATCH /user
Logout
Document resources/user/actions/logout
not found.
GET
/logout
Query Parameter | Type | Description |
---|---|---|
include | [String] | List of attributes to eager load. |
Example:GET /logout