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

Consulta as propriedades de configuração de logon único (SSO) de um aplicativo EIAM.

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

get

*Application

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
ApplicationId	string	Sim	O ID do aplicativo.	app_mkv7rgt4d7i4u7zqtzev2mxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
ApplicationSsoConfig	object	As informações de configuração de logon único (SSO) do aplicativo.
SamlSsoConfig	object	Os parâmetros de configuração de atributos de SSO do aplicativo para o protocolo SAML. Este parâmetro é retornado apenas quando o protocolo SSO do aplicativo é SAML 2.0.
SpSsoAcsUrl	string	A URL do serviço de consumidor de asserção (ACS) SAML do aplicativo, que atua como provedor de serviços (SP).	https://signin.alibabacloud.com/saml-role/sso
SpEntityId	string	O ID da entidade SAML do aplicativo, que atua como SP.	urn:alibaba:cloudcomputing
NameIdFormat	string	O formato NameID padrão para o protocolo SAML. Valores válidos: urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified: Não especificado. O aplicativo determina como analisar o NameID. urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress: Formato de endereço de e-mail. urn:oasis:names:tc:SAML:2.0:nameid-format:persistent: NameID persistente. urn:oasis:names:tc:SAML:2.0:nameid-format:transient: NameID transitório.	urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
NameIdValueExpression	string	A expressão usada para gerar o valor real do NameID para o protocolo SAML.	user.username
DefaultRelayState	string	O valor padrão do RelayState. Quando a solicitação de logon único (SSO) de um usuário é iniciada pelo EIAM, a resposta SAML fornecida pelo EIAM define o RelayState com este valor.	https://home.console.alibabacloud.com
SignatureAlgorithm	string	O algoritmo de assinatura para a asserção SAML.	RSA-SHA256
ResponseSigned	boolean	Especifica se a resposta requer uma assinatura. ResponseSigned e AssertionSigned não podem ser ambos falsos. Valores válidos: true: Uma assinatura é necessária. false: Nenhuma assinatura é necessária.	true
AssertionSigned	boolean	Especifica se a asserção requer uma assinatura. ResponseSigned e AssertionSigned não podem ser ambos falsos. Valores válidos: true: Uma assinatura é necessária. false: Nenhuma assinatura é necessária.	true
AttributeStatements	array<object>	As configurações adicionais de atributos de usuário incluídas na asserção SAML.
	object
AttributeName	string	O nome do atributo na asserção SAML.	https://www.aliyun.com/SAML-Role/Attributes/RoleSessionName
AttributeValueExpression	string	A expressão de valor do atributo na asserção SAML.	user.username
IdPEntityId	string	O ID da entidade que representa o provedor de identidade (IdP) no protocolo SAML.	https://example.com/
OptionalRelayStates	array<object>	Os valores opcionais do RelayState. No cartão do aplicativo no portal de aplicativos, são exibidos nomes para várias URLs de redirecionamento opcionais. Depois que um usuário clica em uma opção e conclui o SSO, o usuário é redirecionado automaticamente para a URL correspondente. Você deve especificar uma URL de redirecionamento padrão antes de poder especificar URLs de redirecionamento opcionais.
	object
RelayState	string	O valor opcional do RelayState. No cartão do aplicativo no portal de aplicativos, são exibidos nomes para várias URLs de redirecionamento opcionais. Depois que um usuário clica em uma opção e conclui o SSO, o usuário é redirecionado automaticamente para a URL correspondente.	https://home.console.alibabacloud.com
DisplayName	string	O nome de exibição do RelayState.	Ram Account SSO
SpSigningCertificates	array	A matriz de certificados de verificação de assinatura do SP configurados no formato PEM. Um máximo de dois certificados pode ser retornado para o console ou chamador da API ler e exibir.	-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----
	string	O certificado de verificação de assinatura do SP configurado no formato PEM.	-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----
RequireAuthnRequestSigned	boolean	O status atual do interruptor de verificação de assinatura de SSO.	true
SpSloResponseUrl	string	A URL de resposta de logout único (SLO) configurada do SP.	https://example.com/api/slo/response
OidcSsoConfig	object	Os parâmetros de configuração de atributos de SSO do aplicativo para o protocolo OpenID Connect (OIDC). Este parâmetro é retornado apenas quando o protocolo SSO do aplicativo é OIDC.
RedirectUris	array	A lista de URIs de redirecionamento suportadas pelo aplicativo.
	string	Uma URI de redirecionamento suportada pelo aplicativo.	https://example.com/oidc/login/callback
PostLogoutRedirectUris	array	A lista de URLs de retorno de chamada de logout suportadas pelo aplicativo.
	string	Uma URL de retorno de chamada de logout na lista de permissões do aplicativo. Quando o aplicativo inicia uma solicitação de logout, o parâmetro post_logout_redirect_uri pode ser especificado.	https://example.com/oidc/login/logout
GrantTypes	array	A lista de tipos de concessão do protocolo OIDC suportados.	authorization_code
	string	Um tipo de concessão do protocolo OIDC suportado. Valores válidos: authorization_code: Modo de código de autorização. implicit: Modo implícito. refresh_token: Modo de token de atualização. urn:ietf:params:oauth:grant-type:device_code: Modo de código de dispositivo. password: Modo de senha.	refresh_token
ResponseTypes	array	Os tipos de resposta suportados pelo aplicativo quando OidcSsoConfig.GrantTypes inclui o modo implícito.	token id_token
	string	O parâmetro ResponseType padrão para o protocolo OIDC. Este parâmetro entra em vigor apenas quando GrantTypes inclui o modo implícito. Valores válidos: token: Retorna apenas o token de acesso. id_token: Retorna apenas o token de ID. token id_token: Retorna tanto o token de acesso quanto o token de ID.	token id_token
GrantScopes	array	O parâmetro de escopo padrão para o protocolo OIDC, que especifica o intervalo de atributos de usuário que o endpoint userinfo ou o token de ID pode retornar.	profile，email
	string	O parâmetro de escopo padrão para o protocolo OIDC, que especifica o intervalo de atributos de usuário que o endpoint userinfo ou o token de ID pode retornar. Valores válidos: openid: O parâmetro OIDC padrão para o ID de usuário exclusivo. profile: Informações detalhadas do usuário. email: Informações de e-mail do usuário. phone: Informações de número de telefone do usuário.	openid
PasswordTotpMfaRequired	boolean	Especifica se a autenticação multifator (MFA) de senha de uso único baseada em tempo (TOTP) é obrigatória para o modo de senha. Este parâmetro entra em vigor apenas quando os GrantTypes especificados para o aplicativo OIDC incluem o modo de senha.	true
PasswordAuthenticationSourceId	string	O ID da fonte de autenticação usada para o modo de senha. Este parâmetro entra em vigor apenas quando os GrantTypes especificados para o aplicativo OIDC incluem o modo de senha.	ia_password
PkceRequired	boolean	Especifica se a Proof Key for Code Exchange (PKCE) (RFC 7636) é obrigatória para o SSO do aplicativo.	true
PkceChallengeMethods	array	O algoritmo usado para calcular o desafio de código no PKCE.	S256
	string	O algoritmo usado para calcular o desafio de código no PKCE. Valores válidos: plain: Texto simples. S256: Algoritmo SHA-256.	S256
AccessTokenEffectiveTime	integer	O período de validade do token de acesso emitido, em segundos. Valor padrão: 1200 (20 minutos).	1200
CodeEffectiveTime	integer	O período de validade do código emitido, em segundos. Valor padrão: 60 (1 minuto).	60
IdTokenEffectiveTime	integer	O período de validade do token de ID emitido, em segundos. Valor padrão: 300 (5 minutos).	1200
RefreshTokenEffective	integer	O período de validade do token de atualização emitido, em segundos. Valor padrão: 86400 (1 dia).	86400
CustomClaims	array<object>	As informações personalizadas do usuário incluídas no token de ID retornado.
	object
ClaimName	string	O nome da claim retornada.	userOuIds
ClaimValueExpression	string	A expressão de valor da claim retornada.	ObjectToJsonString(user.organizationalUnits)
SubjectIdExpression	string	A expressão personalizada para o valor da claim sub retornada no token de ID.	user.userid
AllowedPublicClient	string	Especifica se a aplicação tem permissão para atuar como um cliente público para solicitar o servidor de autorização IDaaS EIAM. Isso é suportado apenas quando o modo de código de autorização e o modo de dispositivo estão ativados. Valor padrão: false.	true
ProtocolEndpointDomain	object	A configuração do endpoint de metadados fornecida pela aplicação.
SamlSsoEndpoint	string	O endpoint que aceita solicitações SAML AuthnRequest. Retornado apenas quando o protocolo SSO da aplicação é SAML 2.0.	https://l1seshcn.aliyunidaas.com/login/app/app_mltuxdwd4lq4eer6tmtlmaxm5e/saml2/sso
SamlMetaEndpoint	string	A URL de metadados para o protocolo SAML. Retornada apenas quando o protocolo SSO da aplicação é SAML 2.0.	https://l1seshcn.aliyunidaas.com/api/v2/app_mltuxdwd4lq4eer6tmtlmaxm5e/saml2/meta
SamlSloEndpoint	string	A URL de logoff único (SLO) SAML no lado do IdP. O provedor de serviços (SP) redireciona os usuários para esta URL para iniciar o logoff único.	https://example.com/saml/slo
OidcIssuer	string	As informações do emissor OIDC. Retornadas apenas quando o protocolo SSO da aplicação é OIDC.	https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oidc
OidcJwksEndpoint	string	A URL JWKS do OIDC. Retornada apenas quando o protocolo SSO da aplicação é OIDC.	https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oidc/jwks
Oauth2AuthorizationEndpoint	string	O endpoint de autorização OAuth 2.0. Retornado apenas quando o protocolo SSO da aplicação é OIDC.	https://l1seshcn.aliyunidaas.com/login/app/app_mltta64q65enci54slingvvsgq/oauth2/authorize
Oauth2RevokeEndpoint	string	O endpoint de revogação de token OAuth 2.0. Retornado apenas quando o protocolo SSO da aplicação é OIDC.	https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/revoke
Oauth2TokenEndpoint	string	O endpoint de token OAuth 2.0. Retornado apenas quando o protocolo SSO da aplicação é OIDC.	https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/token
Oauth2DeviceAuthorizationEndpoint	string	O endpoint de autorização de dispositivo OAuth 2.0. Retornado apenas quando o protocolo SSO da aplicação é OIDC.	https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/device/code
Oauth2UserinfoEndpoint	string	O endpoint userinfo OIDC. Retornado apenas quando o protocolo SSO da aplicação é OIDC.	https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/userinfo
OidcLogoutEndpoint	string	O endpoint de logoff iniciado pelo RP OIDC. Retornado apenas quando o protocolo SSO da aplicação é OIDC.	https://l1seshcn.aliyunidaas.com/login/app/app_mltta64q65enci54slingvvsgq/oauth2/logout
SsoStatus	string	O status de ativação do recurso de SSO da aplicação. Valores válidos: enabled: Ativado. disabled: Desativado.	enabled
InitLoginType	string	O método inicial de logon único (SSO). Valores válidos: only_app_init_sso: O SSO é iniciado apenas pela aplicação. Este é o valor padrão para aplicações OIDC. Se este método for especificado para uma aplicação SAML, InitLoginUrl deverá ser especificado. idaas_or_app_init_sso: O SSO pode ser iniciado pelo portal IDaaS ou pela aplicação. Este é o valor padrão para aplicações SAML. Se este método for especificado para uma aplicação OIDC, InitLoginUrl deverá ser especificado.	only_app_init_sso
InitLoginUrl	string	A URL usada para iniciar o logon único (SSO). Este parâmetro é obrigatório quando o InitLoginType de uma aplicação OIDC é definido como idaas_or_app_init_sso, ou quando o InitLoginType de uma aplicação SAML é definido como only_app_init_sso.	http://127.0.0.1:8000/start_login?enterprise_code=ABCDEF

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "ApplicationSsoConfig": {
    "SamlSsoConfig": {
      "SpSsoAcsUrl": "https://signin.alibabacloud.com/saml-role/sso",
      "SpEntityId": "urn:alibaba:cloudcomputing",
      "NameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified",
      "NameIdValueExpression": "user.username",
      "DefaultRelayState": "https://home.console.alibabacloud.com",
      "SignatureAlgorithm": "RSA-SHA256",
      "ResponseSigned": true,
      "AssertionSigned": true,
      "AttributeStatements": [
        {
          "AttributeName": "https://www.aliyun.com/SAML-Role/Attributes/RoleSessionName",
          "AttributeValueExpression": "user.username"
        }
      ],
      "IdPEntityId": "https://example.com/",
      "OptionalRelayStates": [
        {
          "RelayState": "https://home.console.alibabacloud.com",
          "DisplayName": "SSO de conta RAM"
        }
      ],
      "SpSigningCertificates": [
        "-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----"
      ],
      "RequireAuthnRequestSigned": true,
      "SpSloResponseUrl": "https://example.com/api/slo/response"
    },
    "OidcSsoConfig": {
      "RedirectUris": [
        "https://example.com/oidc/login/callback"
      ],
      "PostLogoutRedirectUris": [
        "https://example.com/oidc/login/logout"
      ],
      "GrantTypes": [
        "refresh_token"
      ],
      "ResponseTypes": [
        "token id_token"
      ],
      "GrantScopes": [
        "openid"
      ],
      "PasswordTotpMfaRequired": true,
      "PasswordAuthenticationSourceId": "ia_password",
      "PkceRequired": true,
      "PkceChallengeMethods": [
        "S256"
      ],
      "AccessTokenEffectiveTime": 1200,
      "CodeEffectiveTime": 60,
      "IdTokenEffectiveTime": 1200,
      "RefreshTokenEffective": 86400,
      "CustomClaims": [
        {
          "ClaimName": "userOuIds",
          "ClaimValueExpression": "ObjectToJsonString(user.organizationalUnits)"
        }
      ],
      "SubjectIdExpression": "user.userid",
      "AllowedPublicClient": "true"
    },
    "ProtocolEndpointDomain": {
      "SamlSsoEndpoint": "https://l1seshcn.aliyunidaas.com/login/app/app_mltuxdwd4lq4eer6tmtlmaxm5e/saml2/sso",
      "SamlMetaEndpoint": "https://l1seshcn.aliyunidaas.com/api/v2/app_mltuxdwd4lq4eer6tmtlmaxm5e/saml2/meta",
      "SamlSloEndpoint": "https://example.com/saml/slo",
      "OidcIssuer": "https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oidc",
      "OidcJwksEndpoint": "https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oidc/jwks",
      "Oauth2AuthorizationEndpoint": "https://l1seshcn.aliyunidaas.com/login/app/app_mltta64q65enci54slingvvsgq/oauth2/authorize",
      "Oauth2RevokeEndpoint": "https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/revoke",
      "Oauth2TokenEndpoint": "https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/token",
      "Oauth2DeviceAuthorizationEndpoint": "https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/device/code",
      "Oauth2UserinfoEndpoint": "https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/userinfo",
      "OidcLogoutEndpoint": "https://l1seshcn.aliyunidaas.com/login/app/app_mltta64q65enci54slingvvsgq/oauth2/logout"
    },
    "SsoStatus": "enabled",
    "InitLoginType": "only_app_init_sso",
    "InitLoginUrl": "http://127.0.0.1:8000/start_login?enterprise_code=ABCDEF"
  }
}

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.