Skip to main content
Die REST-API verfügt jetzt über eine Versionskontrolle. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

Konten für soziale Netzwerke

Verwende die REST-API, um die Social Media-Konten authentifizierter Benutzer*innen zu verwalten.

Informationen zur Verwaltung von Social Media-Konten

Wenn eine Anforderungs-URL keinen {username}-Parameter enthält, ist die Antwort für die angemeldete Benutzerin bzw. den angemeldeten Benutzer bestimmt (Übergeben von Authentifizierungsinformationen mit der Anforderung erforderlich). Zusätzliche private Informationen (z. B. ob die Zwei-Faktor-Authentifizierung für einen Benutzerin aktiviert ist) sind enthalten, wenn die Authentifizierung über OAuth mit dem user-Bereich erfolgt.

List social accounts for the authenticated user

Lists all of your social accounts.

Differenzierte Zugriffstoken für "List social accounts for the authenticated user"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token erfordert keine Berechtigungen.

Parameter für „List social accounts for the authenticated user“

Header
Name, type, BESCHREIBUNG
accept string

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

Abfrageparameter
Name, type, BESCHREIBUNG
per_page integer

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

Standard: 30

page integer

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

Standard: 1

HTTP-Antwortstatuscodes für „List social accounts for the authenticated user“

StatuscodeBESCHREIBUNG
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

Codebeispiele für „List social accounts for the authenticated user“

Beispiel für eine Anfrage

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

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.

Differenzierte Zugriffstoken für "Add social accounts for the authenticated user"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss einen der folgenden Berechtigungssätze aufweisen.:

  • profile:write

Parameter für „Add social accounts for the authenticated user“

Header
Name, type, BESCHREIBUNG
accept string

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

Textparameter
Name, type, BESCHREIBUNG
account_urls array of strings Erforderlich

Full URLs for the social media profiles to add.

HTTP-Antwortstatuscodes für „Add social accounts for the authenticated user“

StatuscodeBESCHREIBUNG
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für „Add social accounts for the authenticated user“

Beispiel für eine Anfrage

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

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.

Differenzierte Zugriffstoken für "Delete social accounts for the authenticated user"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss einen der folgenden Berechtigungssätze aufweisen.:

  • profile:write

Parameter für „Delete social accounts for the authenticated user“

Header
Name, type, BESCHREIBUNG
accept string

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

Textparameter
Name, type, BESCHREIBUNG
account_urls array of strings Erforderlich

Full URLs for the social media profiles to delete.

HTTP-Antwortstatuscodes für „Delete social accounts for the authenticated user“

StatuscodeBESCHREIBUNG
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für „Delete social accounts for the authenticated user“

Beispiel für eine Anfrage

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

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

Differenzierte Zugriffstoken für "List social accounts for a user"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token erfordert keine Berechtigungen.

Dieser Endpunkt kann ohne Authentifizierung werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „List social accounts for a user“

Header
Name, type, BESCHREIBUNG
accept string

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

Pfadparameter
Name, type, BESCHREIBUNG
username string Erforderlich

The handle for the GitHub user account.

Abfrageparameter
Name, type, BESCHREIBUNG
per_page integer

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

Standard: 30

page integer

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

Standard: 1

HTTP-Antwortstatuscodes für „List social accounts for a user“

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für „List social accounts for a user“

Beispiel für eine Anfrage

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