Skip to main content
password-reset-post-challenge Actions トリガーの API オブジェクトには、以下が含まれます。

​
api.access

パスワードのリセットを試みるユーザーのアクセス権を変更します。

​
api.access.deny(reason)

現在のパスワードリセット試行を拒否としてマークします。これにより、エンドユーザーは パスワードリセットフローを完了できなくなります。このActionでリクエストされた ユーザーに関する他の副作用は取り消されません。このActionの完了後、パスワードリセットフローは直ちに停止し、 以降のActionsは実行されません。 パラメータ

​
api.authentication

現在のユーザーのsessionの認証 stateの変更をrequestします。

​
api.authentication.challengeWith(factor, options)

指定した認証要素と任意の追加認証要素を使用して、多要素認証のチャレンジをリクエストします。 多要素認証チャレンジがリクエストされると、ユーザーがそのチャレンジを 完了するまで、後続のActionsは実行されません。ユーザーは、次のいずれかの場合にチャレンジを満たしたと見なされます。
  1. デフォルトの認証要素に対するチャレンジを正常に完了した場合。
  2. additionalFactorsで指定された任意の追加認証要素に対するチャレンジを正常に完了した場合。
リクエストされた認証要素のいずれかが現在のトランザクションですでに正常にチャレンジ済みの場合は、 無視されます。 リクエストされた認証要素がテナントで有効になっていない場合は、無視されます。ユーザーが 登録していない認証要素がリクエストされた場合も、無視されます。リクエストされた認証要素のいずれも有効化または登録されていない場合、認証 トランザクションは失敗します (つまり、ログインは完了しません) 。
ユーザーがチャレンジの要件をまだ満たしていない場合、このメソッドによって認証要素のチャレンジ画面が表示されます。additionalFactorsが指定されている場合、ユーザーは必要に応じて別の認証要素を選択できます。
パラメータ

​
api.authentication.challengeWithAny(factors)

指定された認証要素のいずれかを使用して多要素認証チャレンジをリクエストします (最初に認証要素選択画面が表示されます) 。 MFAチャレンジがリクエストされると、ユーザーがチャレンジを完了するまで、後続のActionsは実行されません。ユーザーは、次のいずれかの場合にチャレンジの要件を満たしたことになります。
  1. いずれかの認証要素によるチャレンジを正常に完了した場合。
リクエストされた認証要素のいずれかが現在のトランザクションですでに正常にチャレンジされている場合、その認証要素は無視されます。 リクエストされた認証要素がtenantで有効になっていない場合、その認証要素は無視されます。ユーザーが登録していない認証要素がリクエストされた場合も、その認証要素は無視されます。リクエストされた認証要素がいずれも有効化または登録されていない場合、認証トランザクションは失敗します (つまり、ログインは完了しません) 。
このメソッドでは、ユーザーがチャレンジの要件をまだ満たしていない場合、認証要素選択画面が表示されます。優先する認証要素がある場合は、api.authentication.challengeWith()メソッドの使用を推奨します。渡される認証要素が1つだけの場合、または有効な認証要素が1つだけの場合は、認証要素選択画面は表示されません。
パラメータ

​
api.redirect

外部リダイレクトを設定し、開始します。

​
api.redirect.encodeToken(options)

クエリ文字列パラメーターのリダイレクト先 (sendUserTo 経由) として使用できるsession tokenを作成します。 このtokenには、リダイレクト先のエンドポイントで真正性を証明する必要があるデータが含まれます。リダイレクト先のエンドポイントでは、 共有secretを使用してJWTの署名を検証することで、データの真正性と完全性を 確認できます。 共有secretはActionのsecretとして保存し、次の場所から読み取れるようにする必要があります。 event.secrets['<secret_name>']. パラメータ

​
api.redirect.sendUserTo(url, options)

このActionの完了直後に、パスワードリセットパイプラインで対象のurlへのブラウザーリダイレクトを実行します。createUrlヘルパーメソッドを使用すると、対象のエンドポイントでデータの真正性と完全性を検証できるよう、データを対象のurlのクエリパラメータとして簡単にエンコードできます。 パラメータ

​
api.redirect.validateToken(options)

データの真正性と完全性を検証しながら、/continue エンドポイントに渡された JWT token にエンコードされたデータを取得します。 パラメータ

​
api.cache

キャッシュを変更します。

​
api.cache.delete(key)

指定されたキーのキャッシュ値のレコードが存在する場合は、削除します。 パラメータ

​
api.cache.get(key)

指定されたキーに対応するキャッシュ値のレコードが存在する場合、それを取得します。レコードが見つかった場合、キャッシュ値は返されるオブジェクトの value プロパティで取得できます。 パラメータ

​
api.cache.set(key, value, options)

指定したキーに文字列値をキャッシュへ保存または更新します。 このキャッシュに保存された値は、設定されたトリガーにスコープが設定されます。 Actions Cache Limits の制限が適用されます。 この方法で保存された値の有効期間は、指定された ttl または expires_at の値までとなります。有効期間が指定されていない場合は、デフォルトで 15 分間となります。有効期間は、Actions Cache Limits に記載された最大 期間を超えることはできません。 重要: このキャッシュは、短期間の一時的なデータ向けに設計されています。項目は、 指定された有効期間内であっても、後続のトランザクションでは利用できない場合があります。 パラメータ

​
api.prompt

カスタムプロンプトをレンダリングします。

​
api.prompt.render(promptId, promptOptions)

カスタムプロンプトをレンダリングします。 パラメータ

​
api.transaction

トランザクションを設定します。

​
api.transaction.setResultUrl(url, options)

パスワードリセット後にユーザーをリダイレクトするURLを設定します。 パラメータ