ジャンプ先

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

otpforgotpasswordの構成の更新

PUT

/oam/services/rest/access/api/v1/config/otpforgotpassword

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

リクエスト

本文()

forgotpasswordリンク・リクエスト・オブジェクトの構成

ルート・スキーマ: ConfigureForgotPasswordLinkRequest

タイプ: object

ソースを表示

• customWebRoot: string
  これは、OTPパスワード忘れアプリケーションのルック・アンド・フィールを変更するためにデプロイされたカスタムWebページのURLパスです。
• defaultOTPForgotPasswordLink: boolean
  ユーザーに対して、OOTBのデフォルトのOTPパスワード忘れページを使用するかどうか。これをtrueに指定すると、次のforgotpasswordURL値は無視されます。
• displayOTPForgotPassworLink: boolean
  OAMにOTPパスワード忘れリンクを表示するかどうか。これをfalseに指定すると、リクエスト・オブジェクト内の他の値はすべて無視されます。
• errorLevel: string
  これは、ユーザーに表示する、エラーのエラー・レベルです。エラー・レベルにinternalを指定すると、エンド・ユーザーに詳細メッセージが表示されます。有効な値は、internalとexternalで、デフォルト値はinternalです。
• forgotPasswordURL: string
  これは、ユーザーのパスワードを変更するために表示される正確なURLです。OAMサーバーに対してローカルにできます。
• localtoOAMServer: boolean
  パスワードを忘れた場合のURLがOAMサーバーのローカルであるか、別の場所にあるか。
• mode: string
  これは、otpchangepasswordアプリケーションがユーザーに提示されるモードを記述します。有効な値のリストは次のとおりです。email -- OTPは、ユーザーのメールに送信されます。sms -- OTPは、SMS経由でユーザーのモバイルに送信されます。userselectchallenge -- OTPは、マスクされたチャレンジ表示のいずれをユーザーが選択したかに基づいて送信されます。userchoose -- OTPは、emailキーワードとsmsキーワードのいずれをユーザーが選択したかに基づいてユーザーに送信されます。

{
    "type":"object",
    "properties":{
        "displayOTPForgotPassworLink":{
            "type":"boolean",
            "description":"Whether to show the OTP forgot password link on OAM or not. If its specified as false, all the other values in the request object are ignored."
        },
        "defaultOTPForgotPasswordLink":{
            "type":"boolean",
            "description":"Whether to use OOTB default OTP forgot password page for user to change his password. f this is specified as true, then the next forgotpasswordURL value is ignored."
        },
        "localtoOAMServer":{
            "type":"boolean",
            "description":"whether the forgot password URL is local to OAM server or at a different location."
        },
        "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 email -- otp will be sent to the user's mail sms -- otp will be sent to user's mobile via sms userselectchallenge -- otp will be sent to user, based on user selecting one of  masked display challenges userchoose -- otp will be sent to user, based on selection of email or  sms keywords."
        },
        "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 and default value is internal."
        },
        "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. "
        }
    }
}

レスポンス

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

• application/json

200レスポンス

OTPパスワード忘れの構成が正常に更新されました

本文()

ルート・スキーマ: ConfigureForgotPasswordLinkResponse

タイプ: object

ソースを表示

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

{
    "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 email -- otp will be sent to the user's mail sms -- otp will be sent to user's mobile via sms userselectchallenge -- otp will be sent to user, based on user selecting one of  masked display challenges userchoose -- otp will be sent to user, based on selection of email or  sms keywords."
        },
        "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 レスポンス

内部サーバー・エラー

例

この例は、OAMのデフォルトのログイン・ページ上でOTPパスワード忘れリンクを有効にする方法を示します。

cURLの例

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"
}