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がユーザーのデバイスで生成されます。
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" }