API オブジェクト

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

`api.access`

アクセストークンの利用可否を設定します。

`api.access.deny(code, reason)`

現在のトークン交換を拒否としてマークします。 パラメータ

非表示パラメータ

string

ログインを拒否する理由となる、プロトコル固有のエラーコード。使用できる値: invalid_scope, invalid_request, server_error

string

アクセストークンのグラントを拒否する理由を、人間が理解しやすい形式で説明します。任意。

`api.accessToken`

発行するアクセストークンの変更をリクエストします。

`api.accessToken.setCustomClaim(key, value)`

発行されるアクセストークンにカスタムクレームを設定します。 パラメータ

非表示パラメータ

string

クレームの名前 (完全修飾 URL を指定する必要がある場合があります) 。

unknown

クレームの値。

`api.cache`

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

`api.cache.delete(key)`

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

非表示パラメータ

string

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

`api.cache.get(key)`

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

非表示パラメータ

string

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

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

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

非表示パラメータ

string

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

string

保存するレコードの値。

cachesetoptions

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

表示 options プロパティ

number

unix epoch からのミリ秒単位の絶対有効期限。キャッシュされたレコードは早期に削除される場合がありますが、指定した expires_at を過ぎて保持されることはありません。注: ttl も指定する場合は、この値を指定しないでください。両方のオプションを指定した場合は、 2 つのうち早い方の有効期限が使用されます。任意。

number

このキャッシュエントリのミリ秒単位の有効期間。キャッシュ値は早期に削除される場合がありますが、指定した ttl を過ぎて保持されることはありません。注: expires_at も指定する場合は、この値を指定しないでください。両方のオプションを指定した場合は、 2 つのうち早い方の有効期限が使用されます。任意。

`api.transaction`

[早期アクセス] トランザクションを変更します。

`api.transaction.addTargetScope(scope)`

[早期アクセス] ターゲットスコープセットにスコープを追加します。追加されたスコープは、すべてのActionsの完了後にクライアントグラントとの共通部分のみが残されます。グラントに含まれていないスコープは、最終的なアクセストークンから通知なく削除されます。

exports.onExecuteCredentialsExchange = async (event, api) => {
  api.transaction.addTargetScope('read:reports');
};

パラメータ

非表示パラメータ

string

追加するスコープ。

`api.transaction.removeTargetScope(scope)`

[早期アクセス] ターゲットスコープセットからスコープを削除します。

exports.onExecuteCredentialsExchange = async (event, api) => {
  api.transaction.removeTargetScope('admin:full');
};

パラメータ

非表示パラメータ

string

削除するスコープ。

`api.transaction.setTargetScopes(scopes)`

[早期アクセス] ターゲットスコープセット全体を置き換えます。すべての Actions の完了後、新しいスコープはクライアントグラントとの共通部分に絞り込まれます。グラントに含まれないスコープは、最終的なアクセストークンから通知なく削除されます。

exports.onExecuteCredentialsExchange = async (event, api) => {
  api.transaction.setTargetScopes(['read:users', 'write:users']);
};

パラメータ

非表示パラメータ

array of string

新しいターゲットスコープセット。

`api.transaction.clearTargetScopes()`

[早期アクセス] ターゲットスコープセット内のすべてのスコープを削除します。

exports.onExecuteCredentialsExchange = async (event, api) => {
  api.transaction.clearTargetScopes();
};

Credentials Exchange

Custom Email Provider

Custom Phone Provider

Custom Token Exchange

Event Stream

Password Reset Post Challenge

Post Change Password

Post Login

Post User Registration

Pre User Registration

Send Phone Message

API オブジェクト

`api.access`

`api.access.deny(code, reason)`

`api.accessToken`

`api.accessToken.setCustomClaim(key, value)`

`api.cache`

`api.cache.delete(key)`

`api.cache.get(key)`

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

`api.transaction`

`api.transaction.addTargetScope(scope)`

`api.transaction.removeTargetScope(scope)`

`api.transaction.setTargetScopes(scopes)`

`api.transaction.clearTargetScopes()`

​api.access

​api.access.deny(code, reason)

​api.accessToken

​api.accessToken.setCustomClaim(key, value)

​api.cache

​api.cache.delete(key)

​api.cache.get(key)

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

​api.transaction

​api.transaction.addTargetScope(scope)

​api.transaction.removeTargetScope(scope)

​api.transaction.setTargetScopes(scopes)

​api.transaction.clearTargetScopes()

`api.access`

`api.access.deny(code, reason)`

`api.accessToken`

`api.accessToken.setCustomClaim(key, value)`

`api.cache`

`api.cache.delete(key)`

`api.cache.get(key)`

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

`api.transaction`

`api.transaction.addTargetScope(scope)`

`api.transaction.removeTargetScope(scope)`

`api.transaction.setTargetScopes(scopes)`

`api.transaction.clearTargetScopes()`