アクショントリガー：ユーザー登録前 - APIオブジェクト

ユーザー登録前アクショントリガーのAPIオブジェクトには以下が含まれます。

登録試行の拒否など、ログインしているユーザーのアクセスを修正します。

ユーザーが登録することを拒否します。このアクションの完了後、サインアップフローはすぐに停止し、以降のアクションは実行されません。

apiオブジェクトに参考情報を返します。

実行間で維持されるデータの保管と取得を行います。

提供されたkeyにキャッシュ済みの値が存在する場合は、それを記述したレコードを削除します。

値がキャッシュから削除されると、CacheWriteResultオブジェクトにtype: "success"を含めて返します。操作に失敗すると、type: "error"を返します。エラーの場合には、返すオブジェクトにcodeプロパティを含めて、失敗の詳細を示します。

提供されたkeyにキャッシュ済みの値が存在する場合は、それを記述したレコードを取得します。レコードが見つかった場合には、返されたオブジェクトのvalueプロパティにキャッシュ済みの値があります。

提供されたkeyにキャッシュが見つかった場合には、キャッシュレコードを返します。キャッシュレコードはvalueプロパティを含むオブジェクトで、このプロパティにはキャッシュ済みの値の他にもexpires_atプロパティが含まれ、レコードの最大有効期間をUNIXエポックからの経過ミリ秒数で示します。

重要：このキャッシュは、短命で一時的なデータ向けに設計されています。項目が所定のライフタイム内であったとしても、後のトランザクションでは利用できないかもしれません。

指定されたkeyのキャッシュに文字列値を保管または更新します。

このキャッシュに保管された値は、それを設定するトリガーにスコープが限定されます。これはアクションのキャッシュ制限の対象になります。

このように保管された値には、指定されたttlまたはexpires_at値までのライフタイムがあります。ライフタイムが指定されない場合には、デフォルトのライフタイムである15分が使用されます。ライフタイムはアクションのキャッシュ制限が定める最大値を超過してはいけません。

登録しているユーザーのメタデータの変更を行います。

登録しているユーザーのメタデータを設定します。user_metadataに保存されたデータは、ユーザーが視覚的に確認でき、編集することができます。

注意：このトリガーはManagement APIを呼び出し、Management APIレート制限を消費します。この要求がレート制限に達し、タイムアウト制限時間内に再試行できなかった場合、APIはDeadline Exceededエラーを返します。

登録しているユーザーのアプリケーションメタデータを設定します。app_metadataに保存されたデータは、ユーザーが視覚的に確認または編集することができません。

注意：このトリガーはManagement APIを呼び出し、Management APIレート制限を消費します。この要求がレート制限に達し、タイムアウト制限時間内に再試行できなかった場合、APIはDeadline Exceededエラーを返します。

apiオブジェクトに参考情報を返します。

拒否されたユーザー登録に対するカスタムのエラーメッセージを構築します。

拒否された登録試行に対するカスタムエラーコードとユーザーへのメッセージを定義します。

ユーザーによる登録試行が拒否されると、現在のアクションが完了次第サインアップフローはすぐに停止し、それ以上のアクションは実行されません。