Actions トリガー: pre-user-registration - API オブジェクト

pre-user-registration Action トリガーの API オブジェクトについて説明します。

pre-user-registration Actions トリガーの API オブジェクトには、以下が含まれます。

​

api.access

ログインしようとしているユーザーのアクセスを変更します。たとえば、ログイン試行を拒否できます。

​

api.access.deny(reason, userMessage)

ユーザーが登録できないようにします。サインアップフローはこの Action の完了直後に停止し、以降の Actions は実行されません。

reason · string

この登録試行を拒否する理由を示す内部向けの理由です。この値は テナントログに表示されます。

userMessage · string

登録試行を拒否する理由をわかりやすく説明するメッセージです。これは エンドユーザー向けインターフェースに直接表示される場合があります。

​

api.user

ログイン中のユーザーのメタデータを変更します。

​

api.user.setAppMetadata(key, value)

ログイン中のユーザーに対して、アプリケーション固有のメタデータを設定します。

注: このメソッドはコールバック内では使用しないでください。このメソッドを呼び出しても、メタデータはすぐには更新されません。 同じフロー内の複数の Action にわたってこのメソッドを複数回呼び出すことができ、エンジンが 変更を集約して、フローが完了する前にメタデータをまとめて更新します。

key · string

設定するメタデータのプロパティです。

value · unknown

メタデータ プロパティの値です。この値を null に設定すると、メタデータ プロパティを削除できます。

​

api.user.setUserMetadata(key, value)

ログイン中のユーザーの一般的なメタデータを設定します。

注: このメソッドはコールバック内では使用しないでください。このメソッドを呼び出しても、メタデータはすぐには更新されません。 同じフロー内の複数の Action でこのメソッドを複数回呼び出すことができ、エンジンが 変更を集約して、フローの完了前にメタデータを一括で更新します。

key · string

設定するメタデータのプロパティ。

value · unknown

メタデータ プロパティの値です。これを null に設定すると、 メタデータ プロパティを削除できます。

​

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.validation

検証エラーを理由にログイン試行を拒否するなど、ログインしようとしているユーザーのアクセスを制御します。

​

api.validation.error(errorCode, errorMessage)

ユーザーが登録できないようにします。サインアップフローはこの Action の完了後すぐに停止し、以降の Actions は実行されません。

errorCode · string

この登録試行を拒否する理由を示す、顧客が定義したエラーコードです。この値は テナントログに表示されます。

errorMessage · string

登録試行を拒否する理由を説明する、顧客が定義したメッセージです。これは エンドユーザー向けインターフェースに直接表示される場合があります。