Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.
REST API теперь имеет версию. Дополнительные сведения см. в разделе Сведения об управлении версиями API.

Учетные записи социальных сетей

Используйте REST API для управления учетными записями социальных параметров пользователей, прошедших проверку подлинности.

Сведения об администрировании учетных записей социальных ролей

Если URL-адрес запроса не содержит параметр, {username} ответ будет для вошедшего пользователя (и вы должны передать сведения о проверке подлинности вместе с запросом).{ % ifversion fpt or ghes or ghec %} Дополнительные личные сведения, такие как включение двухфакторной проверки подлинности пользователя, включаются при проверке подлинности через OAuth с областью user действия.{ % endif %}

List social accounts for the authenticated user

Lists all of your social accounts.

Параметры для "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-ответа для "List social accounts for the authenticated user"

Код состоянияОписание
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

Примеры кода для "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

Работа с GitHub Apps

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

Параметры для "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-ответа для "Add social accounts for the authenticated user"

Код состоянияОписание
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"

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

Работа с GitHub Apps

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

Параметры для "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-ответа для "Delete social accounts for the authenticated user"

Код состоянияОписание
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"

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

Работа с GitHub Apps

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

Параметры для "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-ответа для "List social accounts for a user"

Код состоянияОписание
200

OK

Примеры кода для "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" } ]