REST-API-Endpunkte für soziale Konten - GitHub Enterprise Server 3.19 Docs

Wenn eine Anforderungs-URL keinen {username}-Parameter enthält, gilt die Antwort für dendie angemeldeten Benutzer*in (und Sie müssen Authentifizierungsinformationen mit Ihrer Anforderung übergeben). Zusätzliche private Informationen, z. B. ob ein Benutzer die zweistufige Authentifizierung aktiviert hat, werden bei der Authentifizierung über die Standardauthentifizierung oder OAuth mit dem user Zugriffsbereich eingeschlossen.

Lists all of your social accounts.

works_with_fine_grained_tokens:

no_permission_sets

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Abfrageparameter
Name, Typ, 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`

status_code	BESCHREIBUNG
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

request_example

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 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.

works_with_fine_grained_tokens:

permission_set:

"Profile" user permissions (write)

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Körperparameter
Name, Typ, BESCHREIBUNG
`account_urls` array of strings Erforderlich Full URLs for the social media profiles to add.

status_code	BESCHREIBUNG
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

request_example

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

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.

works_with_fine_grained_tokens:

permission_set:

"Profile" user permissions (write)

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Körperparameter
Name, Typ, BESCHREIBUNG
`account_urls` array of strings Erforderlich Full URLs for the social media profiles to delete.

status_code	BESCHREIBUNG
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

request_example

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

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

works_with_fine_grained_tokens:

no_permission_sets

allows_public_read_access_no_permissions

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`username` string Erforderlich The handle for the GitHub user account.

Abfrageparameter
Name, Typ, 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`

status_code	BESCHREIBUNG
`200`	OK

request_example

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