查询指定EIAM实例下忘记密码策略。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
eiam:GetForgetPasswordConfiguration |
get |
*AuthenticationSource
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| OpenForgetPasswordConfiguration |
object |
忘记密码配置。 |
|
| Enable |
boolean |
是否开启忘记密码,已废弃,参考使用 forgetPasswordStatus 参数。 |
true |
| EnableSms |
boolean |
表示是否开启 SMS 做为忘记密码的认证方法,已废弃,请参考使用 authenticationChannels。 |
true |
| EnableEmail |
boolean |
是否开启邮件做为忘记密码的认证方法,已废弃,请参考使用 authenticationChannels。 |
false |
| ForgetPasswordStatus |
string |
忘记密码配置状态。枚举取值:enabled(开启)、disabled(禁用) |
enabled |
| AuthenticationChannels |
array |
忘记密码认证渠道列表。当 forgetPasswordStatus 取值为 enabled 时必传。枚举取值:email(邮件)、sms(短信)、totp(OTP 动态口令)、web_authn(WebAuthn) |
|
|
string |
忘记密码认证渠道。当 forgetPasswordStatus 取值为 enabled 时必传。枚举取值:email(邮件)、sms(短信)、totp(OTP 动态口令)、web_authn(WebAuthn) |
sms |
示例
正常返回示例
JSON格式
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"OpenForgetPasswordConfiguration": {
"Enable": true,
"EnableSms": true,
"EnableEmail": false,
"ForgetPasswordStatus": "enabled",
"AuthenticationChannels": [
"sms"
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。