社交帐户的 REST API 终结点
使用 REST API 管理经过身份验证的用户的社交帐户。
关于社交帐户管理
如果请求 URL 不包含 {username}
参数,则响应将针对已登录的用户(并且必须使用请求传递 身份验证信息)。 在 user
范围,通过 OAuth 进行身份验证时,将包含其他专用信息,例如用户是否已启用双因素身份验证。
List social accounts for the authenticated user
Lists all of your social accounts.
“List social accounts for the authenticated user”的细粒度访问令牌
此端点支持以下精细令牌类型:
精细令牌不需要任何权限。
“List social accounts for the authenticated user”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: |
“List social accounts for the authenticated user”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
“List social accounts for the authenticated user”的示例代码
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
请求示例
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
Response
Add social accounts for the authenticated user
Add one or more social accounts to the authenticated user's profile.
OAuth app tokens and personal access tokens (classic) need the user
scope to use this endpoint.
“Add social accounts for the authenticated user”的细粒度访问令牌
此端点支持以下精细令牌类型:
精细令牌必须具有以下权限集:
- "Profile" user permissions (write)
“Add social accounts for the authenticated user”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
account_urls array of strings 必须Full URLs for the social media profiles to add. |
“Add social accounts for the authenticated user”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
201 | Created |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
“Add social accounts for the authenticated user”的示例代码
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
请求示例
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"]}'
Response
Delete social accounts for the authenticated user
Deletes one or more social accounts from the authenticated user's profile.
OAuth app tokens and personal access tokens (classic) need the user
scope to use this endpoint.
“Delete social accounts for the authenticated user”的细粒度访问令牌
此端点支持以下精细令牌类型:
精细令牌必须具有以下权限集:
- "Profile" user permissions (write)
“Delete social accounts for the authenticated user”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
account_urls array of strings 必须Full URLs for the social media profiles to delete. |
“Delete social accounts for the authenticated user”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
204 | No Content |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
“Delete social accounts for the authenticated user”的示例代码
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
请求示例
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"]}'
Response
Status: 204
List social accounts for a user
Lists social media accounts for a user. This endpoint is accessible by anyone.
“List social accounts for a user”的细粒度访问令牌
此端点支持以下精细令牌类型:
精细令牌不需要任何权限。
如果仅请求公共资源,则无需身份验证即可使用此终结点。
“List social accounts for a user”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
username string 必须The handle for the GitHub user account. |
名称, 类型, 说明 |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: |
“List social accounts for a user”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | OK |
“List social accounts for a user”的示例代码
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
请求示例
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
Response