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

Configura um provedor de identidade (IdP) de Security Assertion Markup Language (SAML).

Descrição da operação

Durante o logon de single sign-on (SSO) baseado em SAML 2.0, o CloudSSO atua como provedor de serviços (SP) e o sistema de gerenciamento de identidade de uma empresa atua como IdP.

Você pode usar um dos seguintes métodos para configurar um IdP SAML. Você pode obter o arquivo de metadados necessário ou os valores dos parâmetros do seu IdP.

Usar o arquivo de metadados: Você pode especificar o parâmetro EncodedMetadataDocument para fazer upload do arquivo de metadados.
Configurar manualmente o IdP: Você pode especificar manualmente os seguintes parâmetros para o seu IdP: EntityId, LoginUrl, WantRequestSigned e X509Certificate.

Se você já configurou um IdP SAML, as configurações existentes serão substituídas após a chamada desta operação.

Se o IdP for configurado usando o arquivo de metadados, todas as configurações existentes serão substituídas pelas novas configurações.
Se o IdP for configurado manualmente, os valores originais dos parâmetros que forem diferentes dos novos valores dos parâmetros serão substituídos.

Nota

Se o logon SSO estiver ativado, as novas configurações entrarão em vigor imediatamente. Fique atento aos impactos no ambiente de produção.

Este tópico fornece um exemplo de como configurar um IdP usando o arquivo de metadados 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:SetExternalSAMLIdentityProvider

update

*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****
EncodedMetadataDocument	string	Não	O arquivo de metadados do IdP. O valor deste parâmetro é codificado em Base64. O arquivo é fornecido pelo IdP que oferece suporte a SAML 2.0.	PD94bWwgdmVyc2lvbj0iMS4****
SSOStatus	string	Não	O status do logon SSO. Valores válidos: Enabled Disabled (padrão)	Disabled
EntityId	string	Não	O ID da entidade do IdP.	http://www.okta.com/exk3qwgtjhetR2Od****
LoginUrl	string	Não	A URL de logon do IdP.	https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
WantRequestSigned	boolean	Não	Especifica se o CloudSSO precisa assinar as solicitações SAML. As solicitações são enviadas quando os usuários fazem logon no portal do usuário do CloudSSO para iniciar o SSO baseado em SAML. Valores válidos: true false (padrão)	false
X509Certificate	string	Não	O certificado X.509 no formato PEM. Se você especificar este parâmetro, todos os certificados existentes serão substituídos.	MIIC8DCCAdigAwIBAgIQP9eomUYGeoND****
BindingType	string	Não	A vinculação para envio de solicitações SAML. Valores válidos: Post: vinculação HTTP Post. Redirect: vinculação HTTP Redirect.	Redirect

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	63160579-2E1B-57B0-8273-B27427172385
SAMLIdentityProviderConfiguration	object	As configurações do IdP.
EntityId	string	O ID da entidade do IdP.	http://www.okta.com/exk3qwgtjhetR2Od****
SSOStatus	string	O status do logon SSO. Valores válidos: Enabled Disabled	Disabled
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-10T02:57:16Z
WantRequestSigned	boolean	Indica se o CloudSSO precisa assinar as solicitações SAML. As solicitações são enviadas quando os usuários fazem logon no portal do usuário 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-10T02:57:16Z
CertificateIds	array	Os IDs dos certificados de assinatura SAML.
	string	O ID do certificado de assinatura SAML. Vários IDs são separados por vírgulas (,).	[ "idp-c-00buzdx63z8ewtdf**", "idp-c-00gmuxnr2mrek3t2**" ]
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ção HTTP Post. Redirect: vinculação HTTP Redirect.	Redirect

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "63160579-2E1B-57B0-8273-B27427172385",
  "SAMLIdentityProviderConfiguration": {
    "EntityId": "http://www.okta.com/exk3qwgtjhetR2Od****",
    "SSOStatus": "Disabled",
    "DirectoryId": "d-00fc2p61****",
    "EncodedMetadataDocument": "PD94bWwgdmVyc2lvbj0iMS4****",
    "CreateTime": "2021-11-10T02:57:16Z",
    "WantRequestSigned": false,
    "UpdateTime": "2021-11-10T02:57:16Z",
    "CertificateIds": [
      "[ \"idp-c-00buzdx63z8ewtdf****\", \"idp-c-00gmuxnr2mrek3t2****\" ]"
    ],
    "LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml",
    "BindingType": "Redirect"
  }
}

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.