跳至主要内容
REST API 现在已版本化。 有关更多信息,请参阅 "关于 API 版本控制."

社交帐户的 REST API 端点

使用 REST API 管理已认证用户的社交帐户。

关于社交帐户管理

如果请求 URL 不包含 {username} 参数,则响应将针对已登录用户(并且您必须通过您的请求传递 身份验证信息)。当通过 OAuth 使用 user 范围进行身份验证时,会包含其他私人信息,例如用户是否启用了双因素身份验证。

列出已认证用户的社交帐户

列出您所有的社交帐户。

用于“列出已认证用户的社交帐户”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌不需要任何权限。

“列出已认证用户的社交帐户”的参数

标头
名称、类型、描述
accept string

建议设置为application/vnd.github+json

查询参数
名称、类型、描述
per_page integer

每页结果数(最大 100)。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 30

page integer

要获取的结果的页码。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 1

“列出已认证用户的社交帐户”的 HTTP 响应状态码

状态码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

“列出已认证用户的社交帐户”的代码示例

请求示例

get/user/social_accounts
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/social_accounts

响应

状态:200
[ { "provider": "twitter", "url": "https://twitter.com/github" } ]

为已认证用户添加社交帐户

向已认证用户的个人资料添加一个或多个社交帐户。

OAuth 应用程序令牌和个人访问令牌(经典)需要user范围才能使用此端点。

“为已认证用户添加社交帐户”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • "个人资料" 用户权限(写入)

“为已认证用户添加社交账号”的参数

标头
名称、类型、描述
accept string

建议设置为application/vnd.github+json

主体参数
名称、类型、描述
account_urls 字符串数组 必需

要添加的社交媒体资料的完整 URL。

“为已认证用户添加社交账号”的 HTTP 响应状态码

状态码描述
201

已创建

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

422

验证失败,或端点已被滥用。

“为已认证用户添加社交账号”的代码示例

请求示例

post/user/social_accounts
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/social_accounts \ -d '{"account_urls":["https://facebook.com/GitHub","https://www.youtube.com/@GitHub"]}'

响应

状态:201
[ { "provider": "twitter", "url": "https://twitter.com/github" } ]

删除已认证用户的社交账号

从已认证用户的个人资料中删除一个或多个社交账号。

OAuth 应用程序令牌和个人访问令牌(经典)需要user范围才能使用此端点。

“删除已认证用户的社交账号”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • "个人资料" 用户权限(写入)

“删除已认证用户的社交账号”的参数

标头
名称、类型、描述
accept string

建议设置为application/vnd.github+json

主体参数
名称、类型、描述
account_urls 字符串数组 必需

要删除的社交媒体资料的完整 URL。

“删除已认证用户的社交账号”的 HTTP 响应状态码

状态码描述
204

无内容

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

422

验证失败,或端点已被滥用。

“删除已认证用户的社交账号”的代码示例

请求示例

delete/user/social_accounts
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/social_accounts \ -d '{"account_urls":["https://facebook.com/GitHub","https://www.youtube.com/@GitHub"]}'

响应

状态:204

列出用户的社交账号

列出用户的社交媒体账号。此端点可供任何人访问。

“列出用户的社交账号”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌不需要任何权限。

如果仅请求公共资源,则可以使用此端点,无需身份验证。

“列出用户的社交账号”的参数

标头
名称、类型、描述
accept string

建议设置为application/vnd.github+json

路径参数
名称、类型、描述
username 字符串 必需

GitHub 用户帐户的句柄。

查询参数
名称、类型、描述
per_page integer

每页结果数(最大 100)。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 30

page integer

要获取的结果的页码。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 1

“列出用户的社交账号”的 HTTP 响应状态码

状态码描述
200

OK

“列出用户的社交账号”的代码示例

请求示例

get/users/{username}/social_accounts
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/social_accounts

响应

状态:200
[ { "provider": "twitter", "url": "https://twitter.com/github" } ]