GetExternalSAMLIdentityProvider - CloudSSO: Central de Documentação do Alibaba Cloud

Consulta as configurações de um provedor de identidade (IdP) de Security Assertion Markup Language (SAML).

Descrição da operação

Este tópico fornece um exemplo de como consultar as configurações do IdP SAML no diretório d-00fc2p61****.

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

cloudsso:GetExternalSAMLIdentityProvider

get

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DirectoryId	string	Sim	O ID do diretório.	d-00fc2p61****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	96D1E5FF-0301-5636-8D33-071E033CFB82
SAMLIdentityProviderConfiguration	object	As configurações do IdP.
EntityId	string	O ID do IdP.	http://www.okta.com/exk3qwgtjhetR2Od****
SSOStatus	string	Indica se o SSO está ativado. Valores válidos: Enabled Disabled	Enabled
DirectoryId	string	O ID do diretório.	d-00fc2p61****
EncodedMetadataDocument	string	O arquivo de metadados do IdP. O valor deste parâmetro é codificado em Base64.	PD94bWwgdmVyc2lvbj0iMS4****
CreateTime	string	A hora em que o IdP foi configurado pela primeira vez.	2021-11-09T09:30:13Z
WantRequestSigned	boolean	Indica se o CloudSSO precisa assinar solicitações SAML. As solicitações são enviadas quando os usuários fazem logon no portal de usuários do CloudSSO para iniciar o SSO baseado em SAML. Valores válidos: true: false (padrão)	false
UpdateTime	string	A hora em que as configurações do IdP foram modificadas pela última vez.	2021-11-09T09:30:22Z
CertificateIds	array	Os certificados de assinatura SAML.
	string	O ID do certificado de assinatura SAML. Vários IDs são separados por vírgulas (,).	[ "idp-c-00s6c04my7hvv1uj****" ]
LoginUrl	string	A URL de logon do IdP.	https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
BindingType	string	A vinculação para envio de solicitações SAML. Valores válidos: Post: vinculações HTTP Post. Redirect: vinculações HTTP Redirect.	Post

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "96D1E5FF-0301-5636-8D33-071E033CFB82",
  "SAMLIdentityProviderConfiguration": {
    "EntityId": "http://www.okta.com/exk3qwgtjhetR2Od****",
    "SSOStatus": "Enabled",
    "DirectoryId": "d-00fc2p61****",
    "EncodedMetadataDocument": "PD94bWwgdmVyc2lvbj0iMS4****",
    "CreateTime": "2021-11-09T09:30:13Z",
    "WantRequestSigned": false,
    "UpdateTime": "2021-11-09T09:30:22Z",
    "CertificateIds": [
      "[ \"idp-c-00s6c04my7hvv1uj****\" ]"
    ],
    "LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml",
    "BindingType": "Post"
  }
}

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.