用户
单个用户。
属性
最小表示
当资源作为另一个资源的一部分返回时包含。
| 名称 | 类型 | 描述 |
|---|---|---|
| id | 整数 | 唯一标识用户的数值。 |
| login | 字符串 | 在 Github 上设置的登录名。 |
| name | 字符串 | 在 GitHub 上设置的姓名。 |
| vcs_type | 未知 | 用户的 vcs_type。 |
| ro_mode | 未知 | 用户的 ro_mode。 |
标准表示
当资源是请求的主要响应时包含，或者急切加载。
| 名称 | 类型 | 描述 |
|---|---|---|
| id | 整数 | 唯一标识用户的数值。 |
| login | 字符串 | 在 Github 上设置的登录名。 |
| name | 字符串 | 在 GitHub 上设置的姓名。 |
| github_id | 整数 | 在 GitHub 上设置的 ID。 |
| vcs_id | 未知 | 用户的 vcs_id。 |
| vcs_type | 未知 | 用户的 vcs_type。 |
| avatar_url | 字符串 | 在 GitHub 上设置的头像 URL。 |
| education | 布尔值 | 用户是否拥有教育帐户。 |
| allow_migration | 未知 | 用户的 allow_migration。 |
| allowance | 未知 | 用户的 allowance。 |
| ro_mode | 未知 | 用户的 ro_mode。 |
| custom_keys | 未知 | 用户的 custom_keys。 |
| 未知 | 用户的电子邮件。 | |
| is_syncing | 布尔值 | 用户当前是否正在与 Github 同步。 |
| synced_at | 字符串 | 用户上次与 GitHub 同步的时间。 |
| recently_signed_up | 未知 | 用户的 recently_signed_up。 |
| secure_user_hash | 未知 | 用户的 secure_user_hash。 |
| ro_mode | 未知 | 用户的 ro_mode。 |
| confirmed_at | 未知 | 用户的 confirmed_at。 |
| custom_keys | 未知 | 用户的 custom_keys。 |
其他属性
| 名称 | 类型 | 描述 |
|---|---|---|
| repositories | [仓库] | 属于此用户的仓库。 |
| installation | 安装 | 属于用户的安装。 |
| emails | 未知 | 用户的电子邮件。 |
| collaborator | 未知 | 用户的合作者。 |
操作
查找
这将返回有关单个用户的详细信息。
GET
/user/{user.id}
| 模板变量 | 类型 | 描述 |
|---|---|---|
| user.id | 整数 | 唯一标识用户的数值。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| include | [字符串] | 要急切加载的属性列表。 |
示例GET /user/invalid
同步
这将触发用户帐户与其 GitHub 帐户的同步。
POST
/user/{user.id}/sync
| 模板变量 | 类型 | 描述 |
|---|---|---|
| user.id | 整数 | 唯一标识用户的数值。 |
示例POST /user/invalid/sync
当前
这将返回有关当前用户的详细信息。
GET
/user
| 查询参数 | 类型 | 描述 |
|---|---|---|
| include | [字符串] | 要急切加载的属性列表。 |
示例GET /user
更新
未找到文档 resources/user/actions/update。
PATCH
/user
| 接受的参数 | 类型 | 描述 |
|---|---|---|
| user.utm_params | 未知 | 文档缺失。 |
示例PATCH /user
注销
未找到文档 resources/user/actions/logout。
GET
/logout
| 查询参数 | 类型 | 描述 |
|---|---|---|
| include | [字符串] | 要急切加载的属性列表。 |
示例GET /logout