ジャンプ先

• リクエスト
• レスポンス
• 例

otpforgotpasswordの構成の取得

GET

/iam/admin/access/api/v1/config/otpforgotpassword

このREST APIは、otpforgotpassword機能がOAMで有効になっているかどうか、およびデフォルトのログイン・ページに、パスワードを忘れた場合のページへのリンクがあるかどうかを示します。正確なforgotpasswordページのURLも示します。

リクエスト

この操作にはリクエスト・パラメータはありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OTPパスワード忘れ構成が正常に取得されました

本文()

ルート・スキーマ: ConfigureForgotPasswordLinkResponse

タイプ: object

ソースを表示

• customWebRoot(optional): string
  これは、OTPパスワード忘れアプリケーションのルック・アンド・フィールを変更するためにデプロイされたカスタムWebページのURLパスです。
• displayOTPForgotPasswordLink(optional): boolean
  OAMにOTPパスワード忘れリンクを表示するかどうか。これをfalseに指定すると、forgotPasswordURLの値は使用されず、OAMのデフォルトのログイン・ページにリンクが表示されません。
• errorLevel(optional): string
  これは、ユーザーに表示する、エラーのエラー・レベルです。エラー・レベルにinternalを指定すると、エンド・ユーザーに詳細メッセージが表示されます。有効な値は、internalおよびexternalです。
• forgotPasswordURL(optional): string
  これは、ユーザーのパスワードを変更するために表示される正確なURLです。OAMサーバーに対してローカルにできます。
• mode(optional): string
  これは、otpchangepasswordアプリケーションがユーザーに提示されるモードを記述します。有効な値のリストは次のとおりです。1) email -- OTPは、ユーザーのメールに送信されます。2) sms -- OTPは、SMS経由でユーザーのモバイルに送信されます。3) userselectchallenge -- OTPは、マスクされたチャレンジ表示のいずれをユーザーが選択したかに基づいて送信されます。4) userchoose -- OTPは、emailキーワードとsmsキーワードのいずれをユーザーが選択したかに基づいてユーザーに送信されます。5) totp -- 時間に基づいたOTPがユーザーのデバイスで生成されます。

{
    "type":"object",
    "properties":{
        "displayOTPForgotPasswordLink":{
            "type":"boolean",
            "description":"Whether to show the OTP forgot password link on OAM or not. If its specified as false, the value for the forgotPasswordURL is not used and the link is not showed on the OAM default login page."
        },
        "forgotPasswordURL":{
            "type":"string",
            "description":"This is the exact URL that the user will be taken to for changing his password. It can be local to OAM server"
        },
        "mode":{
            "type":"string",
            "description":"This descibes the mode in which the otpchangepassword app will be presented to the user. The valid list of values are 1)email -- otp will be sent to the user's mail. 2)sms -- otp will be sent to user's mobile via sms. 3)userselectchallenge -- otp will be sent to user, based on user selecting one of  masked display challenges. 4)userchoose -- otp will be sent to user, based on selection of email or  sms keywords. 5)totp -- time based otp generated in user's device."
        },
        "errorLevel":{
            "type":"string",
            "description":"This is the error level of the error that will be displayed to the user. Internal error level shows a detailed message to the end user. Valid values are internal and external."
        },
        "customWebRoot":{
            "type":"string",
            "description":"This is the url path of the custom web pages deployed for look and feel changes for the otp forgot password applicaion. "
        }
    }
}

401 レスポンス

未許可

500 レスポンス

内部サーバー・エラー

先頭に戻る

例

この例は、otpforgotpassword機能がOAMで有効になっているかどうかを問い合せる方法を示しています。正確なforgotpasswordページのURLも示します。

レスポンス・ヘッダーの例

curl -X GET http://hostname:port/oam/services/rest/access/api/v1/config/otpforgotpassword/ -H 'authorization: Basic d2VibG9naWM6d2VsY29tZTE=' -H 'content-type: application/json'

レスポンス本文の例

次の例では、レスポンス本文のコンテンツを示しています。

{
"customWebRoot":"SampleLoginWAR","displayOTPForgotPasswordLink":true,
"errorLevelInternal":true,"forgotPasswordURL":"/SampleLoginWAR/pages/otpforgotpassword.jsp","mode":"userselectchallenge"
}

先頭に戻る