Skip to main content
The REST API is now versioned. For more information, see "About API versioning."

社交帐户

使用 REST API 管理经过身份验证的用户的社交帐户。

关于社交帐户管理

如果请求 URL 不含 {username} 参数,则响应将是登录用户的响应(必须随请求传递身份验证信息)。 在通过 作用域为 user 的 OAuth 进行身份验证时,将包含其他专用信息,例如用户是否启用双重身份验证。

List social accounts for the authenticated user

Lists all of your social accounts.

Parameters for "List social accounts for the authenticated user"

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

查询参数
名称, 类型, 说明
per_page integer

The number of results per page (max 100).

默认: 30

page integer

Page number of the results to fetch.

默认: 1

HTTP response status codes for "List social accounts for the authenticated user"

Status codeDescription
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

Code samples for "List social accounts for the authenticated user"

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

Response

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

Add social accounts for the authenticated user

Works with GitHub Apps

Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the user scope.

Parameters for "Add social accounts for the authenticated user"

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

正文参数
名称, 类型, 说明
account_urls array of strings 必须

Full URLs for the social media profiles to add.

HTTP response status codes for "Add social accounts for the authenticated user"

Status codeDescription
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Code samples for "Add social accounts for the authenticated user"

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"]}'

Response

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

Delete social accounts for the authenticated user

Works with GitHub Apps

Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the user scope.

Parameters for "Delete social accounts for the authenticated user"

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

正文参数
名称, 类型, 说明
account_urls array of strings 必须

Full URLs for the social media profiles to delete.

HTTP response status codes for "Delete social accounts for the authenticated user"

Status codeDescription
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Code samples for "Delete social accounts for the authenticated user"

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"]}'

Response

Status: 204

List social accounts for a user

Works with GitHub Apps

Lists social media accounts for a user. This endpoint is accessible by anyone.

Parameters for "List social accounts for a user"

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
username string 必须

The handle for the GitHub user account.

查询参数
名称, 类型, 说明
per_page integer

The number of results per page (max 100).

默认: 30

page integer

Page number of the results to fetch.

默认: 1

HTTP response status codes for "List social accounts for a user"

Status codeDescription
200

OK

Code samples for "List social accounts for a user"

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

Response

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