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

Consulta a política de esquecimento de senha de uma instância EIAM especificada.

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

get

*AuthenticationSource

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

Nenhuma

Parâmetros da solicitação

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
OpenForgetPasswordConfiguration	object	A configuração de esquecimento de senha.
Enable	boolean	Indica se o recurso de esquecimento de senha está ativado. Este parâmetro está obsoleto. Use o parâmetro ForgetPasswordStatus em vez disso.	true
EnableSms	boolean	Indica se o SMS está ativado como método de autenticação para esquecimento de senha. Este parâmetro está obsoleto. Use o parâmetro AuthenticationChannels em vez disso.	true
EnableEmail	boolean	Indica se o e-mail está ativado como método de autenticação para esquecimento de senha. Este parâmetro está obsoleto. Use o parâmetro AuthenticationChannels em vez disso.	false
ForgetPasswordStatus	string	O status da configuração de esquecimento de senha. Valores válidos: enabled e disabled.	enabled
AuthenticationChannels	array	A lista de canais de autenticação para esquecimento de senha. Este parâmetro é obrigatório quando ForgetPasswordStatus está definido como enabled. Valores válidos: email, sms (SMS), totp (OTP) e web_authn (WebAuthn).
	string	O canal de autenticação para esquecimento de senha. Este parâmetro é obrigatório quando ForgetPasswordStatus está definido como enabled. Valores válidos: email, sms (SMS), totp (OTP) e web_authn (WebAuthn).	sms

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "OpenForgetPasswordConfiguration": {
    "Enable": true,
    "EnableSms": true,
    "EnableEmail": false,
    "ForgetPasswordStatus": "enabled",
    "AuthenticationChannels": [
      "sms"
    ]
  }
}

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.