すべてのプロダクト
Search

このプロダクト

    Identity as a Service:GetForgetPasswordConfiguration

    ドキュメントセンター

    Identity as a Service:GetForgetPasswordConfiguration

    最終更新日:Sep 24, 2026

    指定された 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 パラメーターを使用してください。

    deprecated: true
    EnableSms

    boolean

    [非推奨] パスワード忘れの認証方式として SMS が有効かどうかを示します。このパラメーターは非推奨です。代わりに AuthenticationChannels パラメーターを使用してください。

    deprecated: true
    EnableEmail

    boolean

    [非推奨] パスワード忘れの認証方式としてメールが有効かどうかを示します。このパラメーターは非推奨です。代わりに AuthenticationChannels パラメーターを使用してください。

    deprecated: true
    ForgetPasswordStatus

    string

    パスワード忘れの構成ステータス。有効な値:

    • enabled: 有効。

    • disabled: 無効。

    列挙値:

    • disabled :

      無効。

    • enabled :

      有効。

    enabled
    AuthenticationChannels

    array

    パスワード忘れの認証チャンネルのリスト。ForgetPasswordStatus が enabled に設定されている場合は必須です。有効な値:

    • email: メール。

    • sms: SMS。

    • totp: OTP 動的パスワード。

    • web_authn: WebAuthn。

    string

    パスワード忘れの認証チャンネル。ForgetPasswordStatus が enabled に設定されている場合は必須です。有効な値:

    • email: メール。

    • sms: SMS。

    • totp: OTP 動的パスワード。

    • web_authn: WebAuthn。

    列挙値:

    • totp :

      OTP 動的パスワード。

    • sms :

      SMS。

    • web_authn :

      WebAuthn。

    • email :

      メール。

    sms

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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