Actions Triggers: password-reset-post-challenge - API オブジェクト

password-reset-post-challenge Action トリガーの API オブジェクトについて説明します。

password-reset-post-challenge Actions トリガーの API オブジェクトには、次のものが含まれます。

​

api.access

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

​

api.access.deny(reason)

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

reason · string

パスワードリセットを拒否する理由を、人が読める形で説明したものです。これは エンドユーザー向けインターフェースに直接表示される場合があります。

​

api.authentication

現在のユーザーのセッションの認証状態の変更をリクエストします。

​

api.authentication.challengeWith(factor, options)

指定した認証要素と、必要に応じて追加の認証要素を使用して、多要素認証のチャレンジを要求します。

多要素認証のチャレンジが要求されると、そのチャレンジがユーザーによって 完了されるまで、後続の Actions は実行されません。ユーザーは、次のいずれかの状況でチャレンジ要件を満たしたことになります。

1. 既定の認証要素に対するチャレンジを正常に完了した場合。
2. additionalFactors に指定された任意の認証要素に対するチャレンジを正常に完了した場合。

要求された認証要素のいずれかが現在のトランザクションですでに正常にチャレンジ済みの場合、 その要素は無視されます。

要求された認証要素がテナントで有効になっていない場合、その要素は無視されます。要求された認証要素にユーザーが 登録していない場合も、その要素は無視されます。要求された認証要素のいずれも有効化または登録されていない場合、認証 トランザクションは失敗します (つまり、ログインは完了しません) 。

このメソッドを呼び出すと、ユーザーがまだチャレンジ要件を満たしていない場合は、 認証要素のチャレンジ画面が表示されます。additionalFactors が指定されている場合、ユーザーは必要に応じて 別の認証要素を選択できます。

factor · factorselector

初回のチャレンジに使用する認証要素の種類と、その options を示すオブジェクトです。

非表示 認証要素 のプロパティ

type · string

使用できる値: otp, email, webauthn-platform, webauthn-roaming, recovery-code

options · dictionary · optional

options · challengewithoptions · optional

additionalFactors をプロパティとして指定することもできる追加オプションです。

非表示 options のプロパティ

additionalFactors · array of objects · optional

​

api.authentication.challengeWithAny(factors)

指定された認証要素のいずれかを使用して多要素認証のチャレンジを要求します (最初に認証要素の選択 画面が表示されます) 。

多要素チャレンジが要求されると、そのチャレンジが ユーザーによって完了されるまで、以降の Actions は実行されません。ユーザーは、次のいずれかの状況でチャレンジを満たしたことになります。

1. いずれかの認証要素のチャレンジを正常に完了した場合。

要求された認証要素のいずれかが現在のトランザクションですでに正常にチャレンジ済みである場合、それは 無視されます。

要求された認証要素がテナントで有効になっていない場合は無視されます。要求された認証要素にユーザーが 登録していない場合も無視されます。要求された認証要素のいずれも有効化または登録されていない場合、認証 トランザクションは失敗します (つまり、ログインは完了しません) 。

このメソッドを使用すると、ユーザーがまだチャレンジの要件を 満たしていない場合、認証要素の選択画面が表示されます。優先する認証要素がある場合は、api.authentication.challengeWith() メソッド を使用することを推奨します。渡される認証要素が 1 つだけであるか、有効な認証要素が 1 つだけである場合は、認証要素の選択画面は表示されません。

factors · array of objects

認証要素の配列。

​

api.redirect

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

​

api.redirect.encodeToken(options)

クエリ文字列パラメーターとしてリダイレクト先に渡す (sendUserTo 経由) ためのセッショントークンを作成します。 このトークンには、遷移先エンドポイントで真正性を検証できる必要があるデータが含まれます。遷移先エンドポイントは、 共有シークレットを使用して JWT の署名を検証することで、データの真正性と完全性を確認できます。

共有シークレットは Action の secret として保存し、 event.secrets['<secret_name>'] から読み取れるようにする必要があります。

options · tokencreationoptions

生成される URL のクエリパラメーターに機密データをどのようにエンコードするかを 設定します。

非表示 options のプロパティ

expiresInSeconds · number · optional

このトークンの有効期限が切れるまでの秒数

payload · dictionary

リダイレクト先に渡すことを目的とし、その真正性と 完全性を検証できる必要があるデータです。

secret · string

リダイレクト先と共有する JWT の署名に使用するシークレットです。 シークレット値は secret として保存し、 event.secrets['<secret_name>'] を使用して取得する必要があります。

​

api.redirect.sendUserTo(url, options)

この action が完了した直後に、パスワードリセットのパイプラインでブラウザーが対象の url にリダイレクトされるようにします。createUrl ヘルパーメソッドは、データの真正性と完全性を対象エンドポイントで検証できるよう、そのデータを対象の url のクエリパラメーターとしてエンコードする処理を簡略化するために用意されています。

url · string

options · sendusertooptions · optional

非表示 options プロパティ

query · dictionary · optional

リダイレクト URL に追加するクエリ文字列パラメーターを表すオブジェクトです。

​

api.redirect.validateToken(options)

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

options · validatesessiontokenoptions

リダイレクト後に /continue エンドポイントに渡された JWT トークンに エンコードされたデータを取得するためのオプション。

非表示 optionsプロパティ

secret · string

tokenParameterName · string · optional

/continue エンドポイントに送信されたクエリパラメーターまたはボディパラメーターの名前。

​

api.cache

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

​

api.cache.delete(key)

指定した key に対応するキャッシュ値のレコードが存在する場合は、それを削除します。

key · string

削除するキャッシュレコードのキー。

​

api.cache.get(key)

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

key · string

キャッシュに保存されているレコードのキー。

​

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

指定したキーで、キャッシュに文字列値を保存または更新します。

このキャッシュに保存された値のスコープは、それらが設定された Trigger に限定されます。 これらの値には、Actions Cache Limits が適用されます。

この方法で保存された値の有効期間は、指定した ttl または expires_at の値までの 最大 となります。有効期間が指定されていない場合は、 デフォルトで 15 分の有効期間が使用されます。有効期間は、 Actions Cache Limits に記載されている最大時間を超えることはできません。

重要: このキャッシュは、短期間の一時的なデータ向けに設計されています。項目は、 指定された有効期間内であっても、後続のトランザクションでは利用できない場合があります。

key · string

保存するレコードのキーです。

value · string

保存するレコードの値です。

options · cachesetoptions · optional

キャッシュの動作を調整するためのオプションです。

非表示 options のプロパティ

expires_at · number · optional

Unix エポックからの経過時間をミリ秒で表した絶対有効期限です。 キャッシュされたレコードはそれより前に削除される場合がありますが、 指定された expires_at を超えて保持されることはありません。

注: ttl にも値が 指定されている場合、この値は指定しないでください。両方のオプションが指定された場合は、 2 つのうち早い方の有効期限が使用されます。

ttl · number · optional

このキャッシュエントリの存続時間をミリ秒で表した値です。 キャッシュされた値はそれより前に削除される場合がありますが、 指定された ttl を超えて保持されることはありません。

注: expires_at にも値が 指定されている場合、この値は指定しないでください。両方のオプションが指定された場合は、 2 つのうち早い方の有効期限が使用されます。

​

api.prompt

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

​

api.prompt.render(promptId, promptOptions)

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

promptId · string

プロンプトの ID。

promptOptions · promptoptions · optional

レンダリング オプション。

非表示 promptOptions のプロパティ

fields · dictionary · optional

フィールド値を設定するためのキーと値のペア (クライアント側) 。

vars · dictionary · optional

変数を挿入するためのキーと値のペア (サーバー側) 。

​

api.transaction

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

​

api.transaction.setResultUrl(url, options)

パスワードのリセット後に、ユーザーのリダイレクト先となる URL を設定します。

url · string

ユーザーのリダイレクト先の URL。

options · resulturloptions · optional

非表示 options のプロパティ

query · dictionary · optional

URL に含めるクエリパラメーター。