GetForgetPasswordConfiguration API によるパスワード忘れ設定の概要 - EIAM - Alibaba Cloud - Identity as a Service

指定された EIAM インスタンスのパスワード忘れの設定を取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eiam:GetForgetPasswordConfiguration

get

*AuthenticationSource

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
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	パスワード忘れの認証方法として E メールが有効かどうかを示します。このパラメーターは非推奨です。代わりに AuthenticationChannels パラメーターを使用してください。	false
ForgetPasswordStatus	string	パスワード忘れの設定のステータス。有効な値： enabled、disabled。	enabled
AuthenticationChannels	array	パスワード忘れに使用する認証チャネルのリスト。ForgetPasswordStatus が enabled に設定されている場合、このパラメーターは必須です。有効な値： email、sms、totp、web_authn。
	string	認証チャネル。有効な値： email、sms、totp、web_authn。	sms

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。