소셜 계정에 대한 REST API 엔드포인트
REST API를 사용하여 인증된 사용자의 소셜 계정을 관리합니다.
소셜 계정 관리 정보
요청 URL에 {username} 매개 변수가 포함되어 있지 않으면 응답은 로그인한 사용자에 대한 것입니다(요청과 함께 인증 정보를 전달해야 함). 사용자가 2단계 인증을 사용하도록 설정했는지 여부와 같은 추가 개인 정보는 기본 인증 또는 범위를 사용하여 OAuth 를 통해user 인증될 때 포함됩니다.
List social accounts for the authenticated user
Lists all of your social accounts.
Fine-grained access tokens for "List social accounts for the authenticated user"
This endpoint works with the following fine-grained token types:
The fine-grained token does not require any permissions.
"List social accounts for the authenticated user"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: |
HTTP response status codes for "List social accounts for the authenticated user"
| Status code | 설명 |
|---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Code samples for "List social accounts for the authenticated user"
Request example
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_accountsResponse
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.
Fine-grained access tokens for "Add social accounts for the authenticated user"
This endpoint works with the following fine-grained token types:
The fine-grained token must have the following permission set:
- "Profile" user permissions (write)
"Add social accounts for the authenticated user"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
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 code | 설명 |
|---|---|
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"
Request example
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.
Fine-grained access tokens for "Delete social accounts for the authenticated user"
This endpoint works with the following fine-grained token types:
The fine-grained token must have the following permission set:
- "Profile" user permissions (write)
"Delete social accounts for the authenticated user"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
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 code | 설명 |
|---|---|
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"
Request example
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: 204List social accounts for a user
Lists social media accounts for a user. This endpoint is accessible by anyone.
Fine-grained access tokens for "List social accounts for a user"
This endpoint works with the following fine-grained token types:
- GitHub App user access tokens
- GitHub App installation access tokens
- Fine-grained personal access tokens
The fine-grained token does not require any permissions.
This endpoint can be used without authentication if only public resources are requested.
"List social accounts for a user"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
username string 필수The handle for the GitHub user account. |
| 이름, 유형, 설명 |
|---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: |
HTTP response status codes for "List social accounts for a user"
| Status code | 설명 |
|---|---|
200 | OK |
Code samples for "List social accounts for a user"
Request example
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_accountsResponse
Status: 200[
{
"provider": "twitter",
"url": "https://twitter.com/github"
}
]