Esta versão do GitHub Enterprise Server foi descontinuada em 2024-09-25. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.
Pontos de extremidade de API REST para contas de rede social
Use a API REST para gerenciar as contas de rede social dos usuários autenticados.
Sobre a administração de contas de rede social
Se uma URL de solicitação não incluir um parâmetro {username}
, a resposta será para o usuário conectado (e você deverá passar informações de autenticação com sua solicitação). Informações particulares adicionais, como a indicação se um usuário tem a autenticação de dois fatores habilitada, são incluídas quando autenticadas por meio da autenticação Básica ou do OAuth com o escopo user
.
List social accounts for the authenticated user
Lists all of your social accounts.
Tokens de acesso refinados para "List social accounts for the authenticated user"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
O token refinaado não requer permissões.
Parâmetros para "List social accounts for the authenticated user"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: |
Códigos de status de resposta HTTP para "List social accounts for the authenticated user"
Código de status | Descrição |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "List social accounts for the authenticated user"
Exemplo de solicitação
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 acesso refinados para "Add social accounts for the authenticated user"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
O token refinado deve ter os seguintes conjuntos de permissões:
- "Profile" user permissions (write)
Parâmetros para "Add social accounts for the authenticated user"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
account_urls array of strings ObrigatórioFull URLs for the social media profiles to add. |
Códigos de status de resposta HTTP para "Add social accounts for the authenticated user"
Código de status | Descrição |
---|---|
201 | Created |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Add social accounts for the authenticated user"
Exemplo de solicitação
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 acesso refinados para "Delete social accounts for the authenticated user"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
O token refinado deve ter os seguintes conjuntos de permissões:
- "Profile" user permissions (write)
Parâmetros para "Delete social accounts for the authenticated user"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
account_urls array of strings ObrigatórioFull URLs for the social media profiles to delete. |
Códigos de status de resposta HTTP para "Delete social accounts for the authenticated user"
Código de status | Descrição |
---|---|
204 | No Content |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Delete social accounts for the authenticated user"
Exemplo de solicitação
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 acesso refinados para "List social accounts for a user"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinaado não requer permissões.
Esse ponto de extremidade pode ser usado sem autenticação se apenas recursos públicos forem solicitados.
Parâmetros para "List social accounts for a user"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
username string ObrigatórioThe handle for the GitHub user account. |
Nome, Tipo, Descrição |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: |
Códigos de status de resposta HTTP para "List social accounts for a user"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "List social accounts for a user"
Exemplo de solicitação
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"
}
]