FetchOAuthAuthenticationToken - Identity as a Service: Central de Documentação do Alibaba Cloud

Obtém um token de autenticação OAuth válido.

Descrição da operação

Esta API realiza autenticação e autorização de identidade usando um access token emitido pelo IDaaS.

Certifique-se de que o access token tenha permissão para obter tokens de autenticação do aplicativo integrado de Privileged Access Management (PAM) no IDaaS.

Nota

O escopo correspondente é urn:cloud:idaas:pam|authentication_token:obtain.

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}/authenticationTokens/_/actions/fetchOAuthAccessToken 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. O formato é `Bearer ${access_token}`. Nota Insira o access token emitido pelo IDaaS.	Bearer xxxxxx
body	object	Não	O corpo da solicitação.
credentialProviderIdentifier	string	Sim	O identificador do provedor de credenciais.	test_example_identifier
scope	string	Não	O escopo para o protocolo OAuth. Nota Se você não especificar este parâmetro, o escopo do access token OAuth emitido será determinado pela configuração de escopo do provedor de credenciais. Importante Separe múltiplos valores de escopo com espaços.	example:test_01 example:test_02

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes do token de autenticação OAuth.
instanceId	string	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
authenticationTokenId	string	O ID do token de autenticação.	atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx
credentialProviderId	string	O ID do provedor de credenciais.	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx
createTime	integer	A hora em que o token de autenticação foi criado. Este é um timestamp UNIX em milissegundos.	1649830225000
updateTime	integer	A hora em que o token de autenticação foi atualizado pela última vez. Este é um timestamp UNIX em milissegundos.	1649830225000
authenticationTokenType	string	O tipo do token de autenticação. Nota O valor é fixo em `oauth_access_token`, que indica um access token OAuth.	oauth_access_token
revoked	boolean	Indica se o token de autenticação foi revogado.	false
creatorType	string	O tipo do criador do token de autenticação. Valor válido: `application`: Um aplicativo.	application
creatorId	string	O ID do criador do token de autenticação.	app_ngtkgrrxxxxktg5eao6z4xxxxx
consumerType	string	O tipo do consumidor do token de autenticação. Valores válidos: `application`: Um aplicativo. `custom`: Um tipo personalizado.	application
consumerId	string	O ID do consumidor do token de autenticação.	app_ngtkgrrxxxxktg5eao6z4xxxxx
expirationTime	integer	A hora em que o token de autenticação expira. Este é um timestamp UNIX em milissegundos.	1772693568000
oauthAccessTokenContent	object	O conteúdo do access token OAuth.
accessTokenValue	string	O campo `access_token` na resposta do endpoint de token do protocolo OAuth.	DgEBAGP2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
tokenType	string	O campo `token_type` na resposta do endpoint de token do protocolo OAuth.	Bearer
scope	string	O campo `scope` na resposta do endpoint de token do protocolo OAuth.	example:test_01 example:test_02

Exemplos

Resposta de sucesso

JSON formato

{
  "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
  "authenticationTokenId": "atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx",
  "credentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx",
  "createTime": 1649830225000,
  "updateTime": 1649830225000,
  "authenticationTokenType": "oauth_access_token",
  "revoked": false,
  "creatorType": "application",
  "creatorId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
  "consumerType": "application",
  "consumerId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
  "expirationTime": 1772693568000,
  "oauthAccessTokenContent": {
    "accessTokenValue": "DgEBAGP2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "tokenType": "Bearer",
    "scope": "example:test_01 example:test_02"
  }
}

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.