otpforgotpasswordの構成の更新
PUT
/iam/admin/access/api/v1/config/otpforgotpassword
このREST APIは、OAMでotpforgotpassword機能を管理者が構成できるかどうか、およびデフォルトのログイン・ページにパスワードを忘れた場合のページへのリンクがあるかどうかを示します。正確なforgotpasswordページのURLもあります。この機能を有効にするには、OAMでOAAMを有効にする必要があります
リクエスト
forgotpasswordリンク・リクエスト・オブジェクトの構成
ルート・スキーマ: ConfigureForgotPasswordLinkRequest
タイプ:
ソースを表示
object
- customWebRoot(optional): string
これは、OTPパスワード忘れアプリケーションのルック・アンド・フィールを変更するためにデプロイされたカスタムWebページのURLパスです。
- defaultOTPForgotPasswordLink(optional): boolean
ユーザーに対して、OOTBのデフォルトのOTPパスワード忘れページを使用するかどうか。これをtrueに指定すると、次のforgotpasswordURL値は無視されます。
- displayOTPForgotPassworLink(optional): boolean
OAMにOTPパスワード忘れリンクを表示するかどうか。これをfalseに指定すると、リクエスト・オブジェクト内の他の値はすべて無視されます。
- errorLevel(optional): string
これは、ユーザーに表示する、エラーのエラー・レベルです。エラー・レベルにinternalを指定すると、エンド・ユーザーに詳細メッセージが表示されます。有効な値は、internalとexternalで、デフォルト値はinternalです。
- forgotPasswordURL(optional): string
これは、ユーザーのパスワードを変更するために表示される正確なURLです。OAMサーバーに対してローカルにできます。
- localtoOAMServer(optional): boolean
パスワードを忘れた場合のURLがOAMサーバーのローカルであるか、別の場所にあるか。
- mode(optional): string
これは、otpchangepasswordアプリケーションがユーザーに提示されるモードを記述します。有効な値のリストは次のとおりです。1) email -- OTPは、ユーザーのメールに送信されます。2) sms -- OTPは、SMS経由でユーザーのモバイルに送信されます。3) userselectchallenge -- OTPは、マスクされたチャレンジ表示のいずれをユーザーが選択したかに基づいて送信されます。4) userchoose -- OTPは、emailキーワードとsmsキーワードのいずれをユーザーが選択したかに基づいてユーザーに送信されます。5) totp -- ユーザーのデバイスにインストールされたアプリケーションから時間に基づいたOTPが生成されます。
レスポンス
サポートされているメディア・タイプ
- 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 レスポンス
内部サーバー・エラー
例
この例は、OAMのデフォルトのログイン・ページ上でOTPパスワード忘れリンクを有効にする方法を示します。
レスポンス・ヘッダーの例
curl -X PUT http://hostname:port/oam/services/rest/access/api/v1/config/otpforgotpassword/
-H 'authorization: Basic d2VibG9naWM6d2VsY29tZTE='
-H 'content-type: application/json'
-d '{"displayOTPForgotPassworLink":"true","defaultOTPForgotPasswordLink":"false","localToOAMServer":"true",
"forgotPasswordURL":"/otpfp/pages/otpforgotpassword.jsp", "mode":"userselectchallenge"}'
レスポンス本文の例
次の例では、レスポンス本文のコンテンツを示しています。
{ "displayOTPForgotPasswordLink": true, "errorLevelInternal": false, "forgotPasswordURL": "/otpfp/pages/otpforgotpassword.jsp", "mode": "userselectchallenge" }