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

Obtém um provedor de identidade.

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:GetIdentityProvider

get

*IdentityProvider.

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}

Nenhuma

Parâmetros da solicitação

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
IdentityProviderDetail	object	As informações do provedor de identidade.
AdvancedStatus	string	A capacidade de configuração avançada. Valores válidos: disabled: Desativado. enabled: Ativado.	disabled
AuthnSourceSupplier	string	O produto de origem de autenticação, como Okta, Google ou Azure AD. Valores válidos: urn:alibaba:idaas:idp:alibaba:dingtalk: DingTalk. urn:alibaba:idaas:idp:unknown:ldap: LDAP. urn:alibaba:idaas:idp:alibaba:idaas: Alibaba Cloud IDaaS. urn:alibaba:idaas:idp:tencent:wecom: WeCom. urn:alibaba:idaas:idp:bytedance:lark: Lark. urn:alibaba:idaas:idp:microsoft:ad: Active Directory. urn:alibaba:idaas:idp:microsoft:aad: Azure Active Directory. urn:alibaba:idaas:idp:alibaba:sase: Alibaba Cloud SASE.	urn:alibaba:idaas:idp:bytedance:lark
AuthnSourceType	string	O tipo de autenticação, OIDC ou SAML. Valores válidos: urn:alibaba:idaas:authntype:oidc: OIDC. urn:alibaba:idaas:authntype:saml2: SAML.	urn:alibaba:idaas:authntype:oidc
AuthnStatus	string	Indica se o IdP correspondente oferece suporte à autenticação. Valores válidos: disabled: Desativado. enabled: Ativado.	disabled
CreateTime	integer	A hora de criação, no formato de carimbo de data/hora UNIX. Unidade: milissegundos.	1726021079000
Description	string	A descrição do provedor de identidade.	para teste de POC
DingtalkAppConfig	object	A configuração básica do DingTalk.
AppKey	string	O AppKey do aplicativo first-party do DingTalk.	41reopmwoy9s
AppSecret	string	O AppSecret do aplicativo first-party do DingTalk.	REOQ6Cl55kriOd8NOBeqWYLKpHR4p6fdZxxxx
CorpId	string	O CorpId do aplicativo first-party do DingTalk.	3756043633237690761
DingtalkLoginVersion	string	A versão de login por código QR do DingTalk. Valores válidos: old_version : Login por código QR legado do DingTalk. new_version : Novo login por código QR do DingTalk.	old_version
DingtalkVersion	string	A versão do DingTalk. Valores válidos: public_dingtalk: DingTalk padrão. private_dingtalk: DingTalk dedicado.	public_dingtalk
EncryptKey	string	O EncryptKey do aplicativo DingTalk.	29003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d
VerificationToken	string	O VerificationToken do aplicativo DingTalk.	5ba9c127a7abe029003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d
DingtalkProvisioningConfig	object	A configuração de provisionamento do DingTalk. Este valor é retornado apenas para o tipo DingTalk.
AuthedDepartmentIds	array<object>	Os departamentos autorizados do DingTalk.
	object
DeptId	string	O ID do departamento do DingTalk.	123xxx444
DeptName	string	O nome do departamento do DingTalk.	departamento de teste
AuthedUsers	array<object>	A lista de contas autorizadas do DingTalk.
	object
Name	string	O nome de usuário do DingTalk.	zhangsan
UserId	string	O ID de usuário do DingTalk.	130308333929200479
CorpId	string	O CorpId da empresa do DingTalk.	ding_xxxxx
CorpName	string	O nome da empresa do DingTalk.	empresa de teste
EndpointMetadata	object	Os metadados do endpoint.
SamlAcsEndpoint	string	O endpoint do SAML Assertion Consumer Service (ACS).	https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/acs
SamlEntityId	string	O EntityId SAML.	https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta
SamlMetaEndpoint	string	O endpoint de metadados SAML.	https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta
IdentityProviderExternalId	string	O ID externo do provedor de identidade.	idp_xxxx
IdentityProviderId	string	O ID do provedor de identidade.	idp_mwpcwnhrimlr2horx7xgg7pp7y
IdentityProviderName	string	O nome do provedor de identidade.	test
IdentityProviderType	string	O tipo de sincronização do provedor de identidade. Valores válidos: urn:alibaba:idaas:idp:alibaba:dingtalk:pull: DingTalk de entrada. urn:alibaba:idaas:idp:alibaba:dingtalk:push: DingTalk de saída. urn:alibaba:idaas:idp:tencent:wecom:pull: WeCom de entrada. urn:alibaba:idaas:idp:bytedance:lark:pull: Lark de entrada. urn:alibaba:idaas:idp:microsoft:ad:pull: AD de entrada. urn:alibaba:idaas:idp:unknown:ldap:pull: LDAP de entrada. urn:alibaba:idaas:idp:standard:oidc: OIDC padrão. urn:alibaba:idaas:idp:alibaba:sase: OIDC personalizado do SASE.	urn:alibaba:idaas:idp:alibaba:dingtalk:push
InstanceId	string	O ID da instância.	idaas_x2df3bak3uwnapqm6xxxx
LarkConfig	object	A configuração do Lark.
AppId	string	O CorpId do aplicativo personalizado do Lark.	cli_a7a99f53a317100c
AppSecret	string	O AppSecret do aplicativo personalizado do Lark.	REOQ6Cl55kriOd8NOBeqWYLKpHR4p6fdZxxxx
EncryptKey	string	O EncryptKey do aplicativo personalizado do Lark.	VkdWw91mdkrjVFr3ObNwefap21dfbZbK
EnterpriseNumber	string	O número da empresa do Lark.	FX1231xxxx
VerificationToken	string	O VerificationToken do aplicativo personalizado do Lark.	VkdWw91mdkrjVFr3ObNwefap21dfbZbK
LastStatusCheckJobResult	string	O resultado da última verificação de status.	success
LdapConfig	object	As informações do provedor de identidade AD/LDAP.
AdministratorPassword	string	A senha do administrador de AD/LDAP.	123456
AdministratorUsername	string	O nome de usuário do administrador de AD/LDAP.	example.com
CertificateFingerprintStatus	string	Indica se a verificação de impressão digital do certificado está ativada. Valores válidos: disabled: Desativado. enabled: Ativado.	enabled
CertificateFingerprints	array	A lista de impressões digitais de certificado.
	string	A impressão digital do certificado no formato SHA-256 da chave pública.	asdsadaasd
LdapProtocol	string	O protocolo de comunicação de AD/LDAP.	ldap
LdapServerHost	string	O endereço do servidor AD/LDAP.	127.xx.xx.100
LdapServerPort	integer	O endereço do servidor AD/LDAP.	389
StartTlsStatus	string	Indica se o StartTLS está ativado. Valores válidos: disabled: Desativado. enabled: Ativado.	enabled
LockReason	string	O motivo do bloqueio.	financial
LogoUrl	string	A URL do logotipo personalizado do provedor de identidade.	https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg
NetworkAccessEndpointId	string	O ID do endpoint de acesso à rede.	nae_mx4vsadfe6govkqkwckxxxx
OidcConfig	object	A configuração do IdP OIDC.
AuthnParam	object	A configuração de autenticação do cliente OIDC.
AuthnMethod	string	O método de autenticação OIDC.	client_secret_post
ClientId	string	O ID do cliente OIDC.	mkv7rgt4d7i4u7zqtzev2mxxxx
ClientSecret	string	O segredo do cliente OIDC.	CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx
EndpointConfig	object	A configuração de endpoint OIDC.
AuthorizationEndpoint	string	O endpoint de autorização OIDC.	https://example.com/oauth/authorize
Issuer	string	As informações do emissor OIDC.	https://example.com/oauth
JwksUri	string	A URI JWKS do OIDC.	https://example.com/oauth/jwks
TokenEndpoint	string	O endpoint de token OIDC.	https://example.com/oauth/token
UserinfoEndpoint	string	O endpoint de informações do usuário OIDC.	https://example.com/oauth/userinfo
GrantScopes	array	A lista de escopos de concessão OIDC.	openid
	string	O escopo de concessão OIDC.	ou_asdaq1addsxzdq1xxxx
GrantType	string	O tipo de concessão OIDC.	authorization_code
PkceChallengeMethod	string	O método de desafio PKCE. Valores válidos: S256: SHA-256. plain: Texto simples.	S256
PkceRequired	boolean	Indica se o PKCE é usado no modo de concessão AuthorizationCode.	true
SamlConfig	object	A configuração do IdP SAML.
BindingMethod	string	O tipo de vinculação. Valores válidos: HTTP-POST : Vinculação de formulário HTTP POST. HTTP-REDIRECT : Vinculação de redirecionamento HTTP.	HTTP-REDIRECT
Certificates	array<object>	A lista de certificados de assinatura do IdP.
	array<object>	As informações do certificado.
CertificateMetadata	object	Os metadados do certificado.
NotAfter	integer	A data após a qual o certificado não é mais válido.	1704067200000
NotBefore	integer	A data antes da qual o certificado ainda não é válido.	1672531200000
Content	string	O conteúdo do certificado.	-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----
IdPEntityId	string	O ID da entidade do IdP.	http://dc.test.com/adfs/services/trust
IdPSsoUrl	string	A URL de SSO do IdP.	https://dc.test.com/adfs/ls/
MaxClockSkew	integer	A divergência máxima de relógio.	180
RequireRequestSigned	boolean	Indica se as solicitações precisam ser assinadas.	true
WantAssertionsSigned	boolean	Indica se o IdP externo é obrigado a assinar asserções.	true
WantResponseSigned	boolean	Indica se o IdP externo é obrigado a assinar respostas.	true
UdPullConfig	object	A configuração de sincronização de entrada.
GroupSyncStatus	string	Indica se a sincronização de grupos está ativada. Valores válidos: disabled enabled	disabled
IncrementalCallbackStatus	string	O status de callback incremental, que indica se os dados de callback incrementais do IdP são processados. Valores válidos: disabled enabled	disabled
UdSyncScopeConfig	object	A configuração de escopo de sincronização.
SourceScopes	array	A lista de nós de origem para sincronização.
	string	O nó de origem para sincronização.	ou_123xxxx
TargetScope	string	O nó de destino para sincronização.	ou_123xxxx
UdPullStatus	string	Indica se o recurso de sincronização de entrada é suportado. Valores válidos: disabled enabled	disabled
UdPushConfig	object	A configuração de sincronização de saída.
IncrementalCallbackStatus	string	Este campo não está em uso. Ignore-o.	disabled
UdSyncScopeConfigs	array<object>	A lista de configurações de escopo de sincronização.
	object	A lista de configurações de escopo de sincronização.
SourceScopes	array	A lista de nós de origem para sincronização.
	string	O nó de origem para sincronização. Defina isso como um ID de organização.	ou_123xxxx
TargetScope	string	O nó de destino para sincronização.	ou_123xxxx
UdPushStatus	string	Indica se a capacidade de sincronização de saída está ativada. Valores válidos:\n\n- disabled\n\n- enabled.	disabled
UpdateTime	integer	A hora da atualização, no formato de timestamp UNIX. Unidade: milissegundos.	1726021079000
WeComConfig	object	A configuração do WeCom.
AgentId	string	O ID do aplicativo próprio do WeCom.	1242350
AuthorizeCallbackDomain	string	O domínio de callback de autorização.	https://example.com/xxxx
ContactSecret	string	O segredo de contato do WeCom.	mPLLiWv-_9witxxxEJCpk1xkF5hOgBzpRt4kBkxxxx
CorpId	string	O corpId do aplicativo próprio do WeCom.	3562012953454577801
CorpSecret	string	O corpSecret do aplicativo próprio do WeCom.	weaseiszjskejskaj12sjeszojxxxx
TrustableDomain	string	O domínio confiável.	https://example.com
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A

Exemplos

Resposta de sucesso

JSON formato

{
  "IdentityProviderDetail": {
    "AdvancedStatus": "disabled",
    "AuthnSourceSupplier": "urn:alibaba:idaas:idp:bytedance:lark",
    "AuthnSourceType": "urn:alibaba:idaas:authntype:oidc",
    "AuthnStatus": "disabled",
    "CreateTime": 1726021079000,
    "Description": "para teste de POC",
    "DingtalkAppConfig": {
      "AppKey": "41reopmwoy9s",
      "AppSecret": "REOQ6Cl55kriOd8NOBeqWYLKpHR4p6fdZxxxx",
      "CorpId": "3756043633237690761",
      "DingtalkLoginVersion": "old_version",
      "DingtalkVersion": "public_dingtalk",
      "EncryptKey": "29003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d",
      "VerificationToken": "5ba9c127a7abe029003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d"
    },
    "DingtalkProvisioningConfig": {
      "AuthedDepartmentIds": [
        {
          "DeptId": "123xxx444",
          "DeptName": "departamento_teste"
        }
      ],
      "AuthedUsers": [
        {
          "Name": "zhangsan",
          "UserId": "130308333929200479"
        }
      ],
      "CorpId": "ding_xxxxx",
      "CorpName": "empresa_teste"
    },
    "EndpointMetadata": {
      "SamlAcsEndpoint": "https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/acs",
      "SamlEntityId": "https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta",
      "SamlMetaEndpoint": "https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta"
    },
    "IdentityProviderExternalId": "idp_xxxx",
    "IdentityProviderId": "idp_mwpcwnhrimlr2horx7xgg7pp7y",
    "IdentityProviderName": "test",
    "IdentityProviderType": "urn:alibaba:idaas:idp:alibaba:dingtalk:push",
    "InstanceId": "idaas_x2df3bak3uwnapqm6xxxx",
    "LarkConfig": {
      "AppId": "cli_a7a99f53a317100c",
      "AppSecret": "***",
      "EncryptKey": "VkdWw91mdkrjVFr3ObNwefap21dfbZbK",
      "EnterpriseNumber": "FX1231xxxx",
      "VerificationToken": "VkdWw91mdkrjVFr3ObNwefap21dfbZbK"
    },
    "LastStatusCheckJobResult": "success",
    "LdapConfig": {
      "AdministratorPassword": "XXXX",
      "AdministratorUsername": "example.com",
      "CertificateFingerprintStatus": "enabled",
      "CertificateFingerprints": [
        "asdsadaasd"
      ],
      "LdapProtocol": "ldap",
      "LdapServerHost": "127.xx.xx.100",
      "LdapServerPort": 389,
      "StartTlsStatus": "enabled"
    },
    "LockReason": "financial",
    "LogoUrl": "https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg",
    "NetworkAccessEndpointId": "nae_mx4vsadfe6govkqkwckxxxx",
    "OidcConfig": {
      "AuthnParam": {
        "AuthnMethod": "client_secret_post",
        "ClientId": "mkv7rgt4d7i4u7zqtzev2mxxxx",
        "ClientSecret": "CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx"
      },
      "EndpointConfig": {
        "AuthorizationEndpoint": "https://example.com/oauth/authorize",
        "Issuer": "https://example.com/oauth",
        "JwksUri": "https://example.com/oauth/jwks",
        "TokenEndpoint": "https://example.com/oauth/token",
        "UserinfoEndpoint": "https://example.com/oauth/userinfo"
      },
      "GrantScopes": [
        "ou_asdaq1addsxzdq1xxxx"
      ],
      "GrantType": "authorization_code",
      "PkceChallengeMethod": "S256",
      "PkceRequired": true
    },
    "SamlConfig": {
      "BindingMethod": "HTTP-REDIRECT",
      "Certificates": [
        {
          "CertificateMetadata": {
            "NotAfter": 1704067200000,
            "NotBefore": 1672531200000
          },
          "Content": "-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----"
        }
      ],
      "IdPEntityId": "http://dc.test.com/adfs/services/trust",
      "IdPSsoUrl": "https://dc.test.com/adfs/ls/",
      "MaxClockSkew": 180,
      "RequireRequestSigned": true,
      "WantAssertionsSigned": true,
      "WantResponseSigned": true
    },
    "UdPullConfig": {
      "GroupSyncStatus": "disabled",
      "IncrementalCallbackStatus": "disabled",
      "UdSyncScopeConfig": {
        "SourceScopes": [
          "ou_123xxxx"
        ],
        "TargetScope": "ou_123xxxx"
      }
    },
    "UdPullStatus": "disabled",
    "UdPushConfig": {
      "IncrementalCallbackStatus": "disabled",
      "UdSyncScopeConfigs": [
        {
          "SourceScopes": [
            "ou_123xxxx"
          ],
          "TargetScope": "ou_123xxxx"
        }
      ]
    },
    "UdPushStatus": "disabled",
    "UpdateTime": 1726021079000,
    "WeComConfig": {
      "AgentId": "1242350",
      "AuthorizeCallbackDomain": "https://example.com/xxxx",
      "ContactSecret": "mPLLiWv-_9witxxxEJCpk1xkF5hOgBzpRt4kBkxxxx",
      "CorpId": "3562012953454577801",
      "CorpSecret": "weaseiszjskejskaj12sjeszojxxxx",
      "TrustableDomain": "https://example.com"
    }
  },
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}

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.