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

Consulta os detalhes de um provedor de credenciais.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

eiam:GetCredentialProvider

get

*CredentialProvider.

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
CredentialProviderId	string	Sim	O ID do provedor de credenciais.	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
CredentialProvider	object	O provedor de credenciais.
InstanceId	string	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
CredentialProviderId	string	O ID do provedor de credenciais.	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx
CredentialProviderIdentifier	string	O identificador de negócios do provedor de credenciais.	test_example_identifier
CredentialProviderName	string	O nome do provedor de credenciais.	test_example_name
CreateTime	integer	A hora de criação do provedor de credenciais. O valor é um timestamp UNIX em milissegundos.	1649830225000
UpdateTime	integer	A hora de atualização do provedor de credenciais. O valor é um timestamp UNIX em milissegundos.	1649830225000
Description	string	A descrição.	Esta é uma descrição de exemplo
CredentialProviderType	string	O tipo do provedor de credenciais. Valores válidos: oauth: Provedor de credenciais OAuth. jwt: Provedor de credenciais JWT.	oauth
CredentialProviderCreationType	string	O tipo de criação do provedor de credenciais. Valores válidos: system_init: Criado pelo sistema. user_custom: Criado pelo usuário.	user_custom
Status	string	O status do provedor de credenciais. Valores válidos: enabled: Ativado. disabled: Desativado.	enabled
CredentialProviderConfig	object	A configuração do provedor de credenciais.
ProviderCredentialIds	array	A lista de IDs de credenciais que correspondem às configurações sensíveis do provedor de credenciais. Nota O sistema armazena com segurança as informações de configuração sensíveis do provedor de credenciais na forma de credenciais.
	string	O ID da credencial que corresponde à configuração sensível.	cred_mkv7xxxxd7i4u7zqtzev2mxxxx
OAuthProviderConfig	object	A configuração do provedor de credenciais OAuth.
ClientId	string	O client_id no protocolo OAuth, que é o ID do cliente.	client_id_example_xxx
TokenEndpoint	string	O endpoint de token do protocolo OAuth.	https://example.com/token
Scope	string	O escopo no protocolo OAuth, que especifica o escopo de permissões. Nota A configuração de escopo do provedor de credenciais OAuth serve como valor padrão. Se o parâmetro de escopo não for especificado quando você chamar a DeveloperAPI para obter um token de acesso OAuth, a configuração de escopo do provedor de credenciais será usada para a emissão do token. Importante Vários valores de escopo são separados por espaços.	example:test_01 example:test_02
AuthorizationFlow	string	O tipo de fluxo de autorização OAuth. Valores válidos: m2m: Máquina para máquina. user_federation: Federação de usuários.	m2m
AuthorizationEndpoint	string	O endpoint de autorização do protocolo OAuth.	https://example.com/authorize
ProviderVendor	string	O tipo de fornecedor do provedor OAuth. Valores válidos: custom: Personalizado. dingtalk: DingTalk. feishu: Lark. github: GitHub. microsoft: Microsoft. google: Google.	custom
DiscoveryUrl	string	A URL do documento de descoberta OAuth.	https://example.com/.well-known/openid-configuration
SystemRedirectUri	string	A URI de redirecionamento gerada pelo sistema.	https://example.com/callback
PkceEnabled	boolean	Indica se o Proof Key for Code Exchange (PKCE) está ativado.	true
PkceChallengeMethod	string	O algoritmo usado para calcular o desafio de código no PKCE. Valores válidos: S256. plain.	S256
Issuer	string	O endpoint do emissor do protocolo OAuth.	https://example.com/issuer
JwtProviderConfig	object	A configuração do provedor de credenciais JWT.
Issuer	string	O emissor do JWT.	https://test.issuer.com
JwksEndpoint	string	A URL do endpoint JWKs.	https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks
Expiration	integer	O período de validade do JWT. Unidade: segundos.	900
ExpirationCleanupEnabled	boolean	Indica se a limpeza de expiração do JWT está ativada.	true
DerivedShortTokenEnabled	boolean	Indica se o recurso de token curto derivado do JWT está ativado.	false
AllowedTokenIssuers	array	A lista de emissores de JWT permitidos.
	string	O emissor de JWT permitido.	https://test.issuer.com

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "CredentialProvider": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx.",
    "CredentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx.",
    "CredentialProviderIdentifier": "test_example_identifier.",
    "CredentialProviderName": "test_example_name.",
    "CreateTime": 1649830225000,
    "UpdateTime": 1649830225000,
    "Description": "Esta é uma descrição de exemplo.",
    "CredentialProviderType": "oauth.",
    "CredentialProviderCreationType": "user_custom.",
    "Status": "enabled.",
    "CredentialProviderConfig": {
      "ProviderCredentialIds": [
        "cred_mkv7xxxxd7i4u7zqtzev2mxxxx."
      ],
      "OAuthProviderConfig": {
        "ClientId": "client_id_example_xxx.",
        "TokenEndpoint": "https://example.com/token.",
        "Scope": "example:test_01 example:test_02",
        "AuthorizationFlow": "m2m\n",
        "AuthorizationEndpoint": "https://example.com/authorize\n",
        "ProviderVendor": "custom",
        "DiscoveryUrl": "https://example.com/.well-known/openid-configuration\n",
        "SystemRedirectUri": "https://example.com/callback",
        "PkceEnabled": true,
        "PkceChallengeMethod": "S256\n",
        "Issuer": "https://example.com/issuer\n"
      },
      "JwtProviderConfig": {
        "Issuer": "https://test.issuer.com.",
        "JwksEndpoint": "https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks.",
        "Expiration": 900,
        "ExpirationCleanupEnabled": true,
        "DerivedShortTokenEnabled": true,
        "AllowedTokenIssuers": [
          "https://test.issuer.com."
        ]
      }
    }
  }
}

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.