GetOAuthAuthorizationSession - : Central de Documentação do Alibaba Cloud

Consulta o status atual e o resultado da autorização de uma sessão de autorização OAuth.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

POST /v2/{instanceId}/oauthAuthorizationSessions/_/actions/get HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Authorization	string	Sim	As informações de autenticação. Formato: Bearer ${access_token}. Nota Insira o Access Token emitido pelo IDaaS.	Bearer xxxxxx.
body	object	Não	O corpo da solicitação.
sessionUri	string	Sim	A URI da sessão de autorização. Nota Retornada pela chamada FetchOAuthAuthenticationToken.	urn:ietf:params:oauth:request_uri:atpoas_01l6ljnvrpc5niakl3gj3amxxxxxx.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes da sessão de autorização OAuth.
instanceId	string	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx.
sessionId	string	O ID da sessão de autorização.	atpoas_01l6losojlojbbv01adsq56xxxxx.
sessionUri	string	A URI da sessão de autorização.	urn:ietf:params:oauth:request_uri:atpoas_01l6ljnvrpc5niakl3gj3amxxxxxx.
sessionStatus	string	O status da sessão de autorização. Valores válidos: expired : expired. pending : pending. completed : completed. failed : failed. callback_received : callback_received.	pending.
credentialProviderIdentifier	string	O identificador comercial do provedor de credenciais.	test_example_identifier.
consumerType	string	O tipo de consumidor do token de autenticação. Valores válidos: application : application. custom : custom.	application.
consumerId	string	O ID do consumidor do token de autenticação.	app_ngtkgrrxxxxktg5eao6z4xxxxx.
creatorType	string	O tipo de criador do token de autenticação. Valores válidos: application : application.	application.
creatorId	string	O ID do criador do token de autenticação.	app_ngtkgrrxxxxktg5eao6z4xxxxx.
authorizationUrl	string	A URL de autorização do usuário.	https://login.dingtalk.com/oauth2/auth?client_id=...
expirationTime	integer	A hora de expiração do token de autenticação. Timestamp UNIX em milissegundos.	1704153600000
authenticationTokenId	string	O ID do token de autenticação.	atntkn_01l6lot7o4e4r77oelp6qtuxxxxx.
errorCode	string	O código de erro.	access_denied.
errorDescription	string	A descrição do erro.	The user denied the authorization request.

Exemplos

Resposta de sucesso

JSON formato

{
  "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
  "sessionId": "atpoas_01l6losojlojbbv01adsq56xxxxx",
  "sessionUri": "urn:ietf:params:oauth:request_uri:atpoas_01l6ljnvrpc5niakl3gj3amxxxxxx",
  "sessionStatus": "pending",
  "credentialProviderIdentifier": "test_example_identifier",
  "consumerType": "application",
  "consumerId": "app_ngtkgrrxxxxktg5eao6z4xxxxx\n",
  "creatorType": "application",
  "creatorId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
  "authorizationUrl": "https://login.dingtalk.com/oauth2/auth?client_id=...",
  "expirationTime": 1704153600000,
  "authenticationTokenId": "atntkn_01l6lot7o4e4r77oelp6qtuxxxxx",
  "errorCode": "access_denied",
  "errorDescription": "The user denied the authorization request"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.