API オブジェクト

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

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

​

api.access

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

​

api.access.deny(code, reason)

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

パラメータ

非表示 パラメータ

code · string

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

reason · string

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

​

api.accessToken

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

​

api.accessToken.setCustomClaim(key, value)

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

パラメータ

非表示 パラメータ

key · string

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

value · unknown

クレームの値。

​

api.cache

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

​

api.cache.delete(key)

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

パラメータ

非表示 パラメータ

key · string

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

​

api.cache.get(key)

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

パラメータ

非表示 パラメータ

key · string

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

​

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

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

このキャッシュに保存された値は、設定されたトリガーのスコープ内でのみ利用できます。 また、Actions Cache Limits が適用されます。

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

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

パラメータ

非表示 パラメータ

key · string

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

value · string

保存するレコードの値。

options · cachesetoptions

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

表示 options プロパティ

expires_at · number

unix epoch からのミリ秒単位の絶対有効期限。 キャッシュされたレコードは早期に削除される場合がありますが、 指定した expires_at を過ぎて保持されることはありません。

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

ttl · number

このキャッシュエントリのミリ秒単位の有効期間。 キャッシュ値は早期に削除される場合がありますが、 指定した ttl を過ぎて保持されることはありません。

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

​

api.transaction

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

​

api.transaction.addTargetScope(scope)

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

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

パラメータ

非表示 パラメータ

scope · string

追加するスコープ。

​

api.transaction.removeTargetScope(scope)

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

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

パラメータ

非表示 パラメータ

scope · string

削除するスコープ。

​

api.transaction.setTargetScopes(scopes)

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

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

パラメータ

非表示 パラメータ

scopes · array of string

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

​

api.transaction.clearTargetScopes()

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

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