Skip to main content
Ahora la API de REST tiene control de versiones. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API de REST para cuentas sociales

Usa la API de REST para administrar las cuentas de red social de los usuarios autenticados.

Acerca de la administración de cuentas de red social

Si una dirección URL de solicitud no incluye un parámetro {username}, la respuesta será para el usuario que ha iniciado sesión (y debe pasar la información de autenticación con la solicitud). Información privada adicional, como si un usuario tiene habilitada la autenticación en dos fases, se incluye cuando se autentica a través de Autenticación básica o OAuth con el ámbito user.

List social accounts for the authenticated user

Lists all of your social accounts.

Tokens de acceso específicos para "List social accounts for the authenticated user"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado no requiere ningún permiso.

Parámetros para "List social accounts for the authenticated user"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de consulta
Nombre, Tipo, Descripción
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "List social accounts for the authenticated user"

status codeDescripción
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

Ejemplos de código para "List social accounts for the authenticated user"

Ejemplo de solicitud

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" \ http(s)://HOSTNAME/api/v3/user/social_accounts

Response

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

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.

Tokens de acceso específicos para "Add social accounts for the authenticated user"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Profile" user permissions (write)

Parámetros para "Add social accounts for the authenticated user"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros del cuerpo
Nombre, Tipo, Descripción
account_urls array of strings Requerido

Full URLs for the social media profiles to add.

Códigos de estado de respuesta HTTP para "Add social accounts for the authenticated user"

status codeDescripción
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Add social accounts for the authenticated user"

Ejemplo de solicitud

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" \ http(s)://HOSTNAME/api/v3/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

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.

Tokens de acceso específicos para "Delete social accounts for the authenticated user"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Profile" user permissions (write)

Parámetros para "Delete social accounts for the authenticated user"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros del cuerpo
Nombre, Tipo, Descripción
account_urls array of strings Requerido

Full URLs for the social media profiles to delete.

Códigos de estado de respuesta HTTP para "Delete social accounts for the authenticated user"

status codeDescripción
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Delete social accounts for the authenticated user"

Ejemplo de solicitud

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" \ http(s)://HOSTNAME/api/v3/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.

Tokens de acceso específicos para "List social accounts for a user"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado no requiere ningún permiso.

Este punto de conexión se puede usar sin autenticación si solo se solicitan recursos públicos.

Parámetros para "List social accounts for a user"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
username string Requerido

The handle for the GitHub user account.

Parámetros de consulta
Nombre, Tipo, Descripción
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "List social accounts for a user"

status codeDescripción
200

OK

Ejemplos de código para "List social accounts for a user"

Ejemplo de solicitud

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" \ http(s)://HOSTNAME/api/v3/users/USERNAME/social_accounts

Response

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