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

Obtém o texto em claro de um segredo.

Descrição da operação

Esta API usa um token de acesso do IDaaS para autenticação e autorização.

O token de acesso deve ter permissões para obter credenciais estáticas para o aplicativo integrado de gerenciamento de acesso privilegiado (PAM) no IDaaS.

Nota

O escopo obrigatório é urn:cloud:idaas:pam|credential: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

GET /v2/{instanceId}/credentials/_/actions/obtain HTTP/1.1

Parâmetros de caminho

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Authorization	string	Sim	Informações de autenticação. O formato é Bearer ${access_token}. Nota Use um token de acesso emitido pelo IDaaS.	Bearer xxxxxx
credentialIdentifier	string	Sim	O identificador da credencial a ser obtida.	credential_identifier_test

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes da credencial.
instanceId	string	O ID da instância EIAM.	idaas_ue2jvisn35ea5lmthk267xxxxx
credentialId	string	O ID da credencial.	cred_mkv7rgt4d7i4u7zqtzev2mxxxx
status	string	O status da credencial. Valores válidos: enabled: A credencial pode ser usada. disabled: A credencial não pode ser usada.	enabled
credentialIdentifier	string	O identificador da credencial.	credential_identifier_test
credentialName	string	O nome da credencial.	credential_name
credentialSubjectType	string	O tipo de entidade da credencial. Valores válidos: authentication_token_provider: Um provedor de token de autenticação.	authentication_token_provider
credentialSubjectId	string	O ID da entidade da credencial.	apt_werthgfdsasffxxxxx
credentialScenarioLabel	string	O cenário de uso da credencial. Valores válidos: llm: Para uso com um modelo de linguagem grande. saas: Para uso com um aplicativo SaaS de terceiros.	llm
credentialType	string	O tipo de credencial. Valores válidos: api_key: A credencial é uma chave de API. oauth_client: A credencial representa um cliente OAuth.	api_key
credentialCreationType	string	Indica como a credencial foi criada. Valores válidos: system_init: Iniciada pelo sistema. user_custom: Criada pelo usuário.	user_custom
description	string	A descrição da credencial.	credential_description
createTime	integer	A hora de criação da credencial, formatada como um timestamp Unix em milissegundos.	1649830225000
updateTime	integer	A hora da última atualização da credencial, formatada como um timestamp Unix em milissegundos.	1649830227000
credentialContent	object	O conteúdo detalhado da credencial. A estrutura deste objeto depende do valor de credentialType.
oauthClientContent	object	Contém detalhes para uma credencial de cliente OAuth. Retornado apenas quando credentialType é oauth_client.
clientId	string	The `client_id` for OAuth 2.0.	dmvncmxersdxxxxxx
clientSecret	string	The `client_secret` for OAuth 2.0.	nsklnertyt5ddwizncxxxx
apiKeyContent	object	Contém detalhes para uma credencial de chave de API. Retornado apenas quando credentialType é api_key.
apiKey	string	The API key value.	sk-nsklncmwizncxxxx
credentialSharingScope	string	O escopo de compartilhamento da credencial, como se ela é exclusiva para uma conta específica.	user_exclusive
exclusiveUserId	string	O ID da conta que possui exclusivamente a credencial. Este campo está presente apenas quando credentialSharingScope é user_exclusive.	user_xxx
credentialExternalId	string

Exemplos

Resposta de sucesso

JSON formato

{
  "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
  "credentialId": "cred_mkv7rgt4d7i4u7zqtzev2mxxxx",
  "status": "enabled",
  "credentialIdentifier": "credential_identifier_test",
  "credentialName": "credential_name",
  "credentialSubjectType": "authentication_token_provider",
  "credentialSubjectId": "apt_werthgfdsasffxxxxx",
  "credentialScenarioLabel": "llm",
  "credentialType": "api_key",
  "credentialCreationType": "user_custom",
  "description": "credential_description",
  "createTime": 1649830225000,
  "updateTime": 1649830227000,
  "credentialContent": {
    "oauthClientContent": {
      "clientId": "dmvncmxersdxxxxxx",
      "clientSecret": "nsklnertyt5ddwizncxxxx"
    },
    "apiKeyContent": {
      "apiKey": "sk-nsklncmwizncxxxx\n"
    }
  },
  "credentialSharingScope": "user_exclusive",
  "exclusiveUserId": "user_xxx",
  "credentialExternalId": ""
}

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.