首页 应用身份服务 (IDaaS) EIAM 云身份服务 开发参考 OpenAPI参考指南 API目录 密码策略 GetForgetPasswordConfiguration - 查询EIAM忘记密码策略

GetForgetPasswordConfiguration - 查询EIAM忘记密码策略

更新时间: 2024-12-17 18:56:39

查询指定EIAM实例下忘记密码策略。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eiam:GetForgetPasswordConfigurationget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A
OpenForgetPasswordConfigurationobject

忘记密码配置。

Enableboolean

是否开启忘记密码,已废弃,参考使用 forgetPasswordStatus 参数。

true
EnableSmsboolean

表示是否开启 SMS 做为忘记密码的认证方法,已废弃,请参考使用 authenticationChannels。

true
EnableEmailboolean

是否开启邮件做为忘记密码的认证方法,已废弃,请参考使用 authenticationChannels。

false
ForgetPasswordStatusstring

忘记密码配置状态。枚举取值:enabled(开启)、disabled(禁用)

enabled
AuthenticationChannelsarray

忘记密码认证渠道列表。当 forgetPasswordStatus 取值为 enabled 时必传。枚举取值:email(邮件)、sms(短信)

AuthenticationChannelstring

忘记密码认证渠道。当 forgetPasswordStatus 取值为 enabled 时必传。枚举取值:email(邮件)、sms(短信)

sms

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇: SetPasswordComplexityConfiguration - 设置EIAM密码复杂度策略 下一篇: GetPasswordInitializationConfiguration - 查询EIAM密码初始化策略
阿里云首页 应用身份服务 (IDaaS) 相关技术圈