パスワードリセット のスクリプトインクルード

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：6分

    • パスワードリセット プラグインでは、パスワードリセットプロセスを実装するスクリプトインクルードがインストールされます。機能を拡張できるように、ベースシステムのスクリプトインクルードではそれぞれ、カスタマイズした「拡張スクリプト」を呼び出すための拡張ポイントが提供されています。

    「拡張スクリプト カテゴリー」では、拡張スクリプトの特定の動作タイプ (認証情報ストア、検証、識別タイプ、ポストプロセッサーなど) について説明しています。

    「登録チェック」スクリプトインクルード

    登録チェック スクリプトインクルードはすべて、次のパラメーターを受け取り、ユーザーがパスワードリセットに登録されているかどうかを示すブール値を返します。
    • params.userId：チェックするユーザーの sys_id (テーブル：[sys_user])。
    • params.verificationId：チェックする検証の sys_id (テーブル：[pwd_verification])。
    名前 説明
    PwdAlwaysEnrolled ユーザーが登録されているかどうかのデフォルトのチェック。常に true を返します。
    PwdMockIsEnrolled ユーザーが登録されているかどうかのデフォルトのチェック。常に true を返します。
    PwdQuestionsEnrollmentCheck セキュリティの質問による検証を使用して、ユーザーがパスワードリセットに登録されているかどうかを判別します。
    PwdSMSEnrollmentCheck SMS 検証を使用して、ユーザーがパスワードリセットに登録されているかどうかを判別します。

    「識別フォーム プロセッサー」スクリプトインクルード

    識別フォーム プロセッサー スクリプトインクルードは、識別処理を拡張する機能を提供します。

    識別フォーム プロセッサー スクリプトインクルードはすべて、次のパラメーターを受け取り、要求された入力に対応するユーザーの sys_id を返します。ユーザーが識別されなかった場合は、null を返します。
    • params.processId：呼び出し側のパスワードリセット プロセスの sys_id (テーブル：[pwd_process])。
    • param request：フォーム要求オブジェクト。request.getParameter('<element-id>') を使用してフォーム内のフィールドにアクセスできます。サポートされている要求パラメータは sysparm_user_id (フォームに入力されたユーザー識別子の値) です。
    名前 説明
    PwdIdentifyViaEmail メールアドレスを確認してユーザーの本人確認を行います。
    PwdIdentifyViaUsername ユーザー名を確認してユーザーの本人確認を行います。

    「登録フォーム プロセッサー」スクリプトインクルード

    登録フォーム プロセッサー」スクリプトインクルードは、登録フォームの処理を拡張する機能を提供します。

    登録フォーム プロセッサー スクリプトインクルードはすべて、次のパラメーターを受け取り、ユーザーが正常に登録されたかどうかを示すブール値を返します。
    • params.userId：登録を試みているユーザーの sys_id (テーブル：[sys_user])。
    • params.verificationId：登録に使用された検証の sys_id (テーブル：[pwd_verification])。
    • params.enrollmentId：この登録プロセスの sys_id。
    • request：フォーム要求オブジェクト。request.getParameter('<element-id>') を使用してフォーム内のフィールドにアクセスできます。
    登録プロセスのステータスに次の情報を追加してください。
    • gs.getSession().putProperty("result.status",status)：ユーザーが正常に登録されたかどうか。
    • gs.getSession().putProperty("result.message",message)：UI に返す関連メッセージ (詳細なエラーメッセージなど)。
    • gs.getSession().putProperty("result.value",value)：登録に関連付けられたカスタムの値。
    名前 説明
    PwdEnrollQuestionsProcessor 検証の質問と回答を処理します。
    PwdEnrollSampleProcessor サンプル検証用の登録プロセッサーを提供します。
    PwdEnrollSMSProcessor SMS 検証用の登録プロセッサを提供します。

    「ユーザーアカウントのルックアップ」スクリプトインクルード

    ユーザーアカウントのルックアップ スクリプトインクルードは、指定したユーザーの認証情報ストアの account_id を返します。

    次のパラメーターは、指定したユーザーの認証情報ストアの account_id を返します。params.userId は確認中のユーザーの sys_id です (テーブル：[sys_user])。
    名前 説明
    PwdDefaultUserAccountLookup user_id からユーザーアカウントをルックアップして認証情報ストア内のアカウントに返すデフォルト スクリプトを提供します。デフォルトのマッピングでは、ユーザー名をアカウント名として使用します。

    「パスワード生成」スクリプトインクルード

    パスワード生成スクリプトインクルードは、次のパラメーターを受け取り、自動生成された文字列パスワードを返します。

    params.credentialStoreId：呼び出し側のパスワードリセット プロセスの sys_id (テーブル：[pwd_process])。

    名前 説明
    PwdDefaultAutoGenPassword ランダムな単語と 4 桁の数字で構成されるパスワードを生成します。

    「検証プロセッサー」スクリプトインクルード

    ユーザーの ID が確認された場合、検証プロセッサー スクリプトインクルードは true を返します。

    検証プロセッサー スクリプトインクルードは、次のパラメーターを受け取ります。
    • params.resetRequestId：現在のパスワードリセット要求の sys_id (テーブル：[pwd_reset_request])。
    • params.userId：検証するユーザーの sys_id (テーブル：[sys_user])。
    • params.verificationId：検証の sys_id (テーブル：[pwd_verification])。
    • request：フォーム要求オブジェクト。request.getParameter('<element-id>') を使用してフォーム内のフィールドにアクセスします。
    名前 説明
    PwdVerifyPersonalDataConfirmationProcess ユーザーが回答を受け入れることを確認します。
    PwdVerifyPersonalDataProcessor ユーザーの回答がシステムで想定されているデータと一致することを確認します。
    PwdVerifyQuestionsProcessor 検証フォームの 2 ページ目のユーザー入力について質問と回答の検証を提供します。
    PwdVerifySimpleProcessor 検証フォームの 2 ページ目のユーザー入力について簡易な検証を提供します。
    PwdVerifySMSProcessor 検証フォームの 2 ページ目のユーザー入力について SMS 検証を提供します。

    「ポスト プロセッサー」スクリプトインクルード

    ポスト プロセッサー スクリプトインクルードは、パスワードリセット プロセス完了後のカスタム アクションを実行します。

    ポスト プロセッサー スクリプトインクルードはすべて、次のパラメーターを受け取ります。
    • params.resetRequestId：現在のパスワードリセット要求の sys_id (テーブル：[pwd_reset_request])。
    • params.wfSuccess：ワークフローが正常に完了したかどうかを示すフラグ。正常に完了した場合のみ true を返します。
    名前 説明
    PwdPostProcessor プロセス完了後に、成功、失敗、または両方の条件に対応するアクションを実行します。