アクショントリガー：資格情報の交換 - APIオブジェクト

資格情報交換アクショントリガーのAPIオブジェクトには以下が含まれます。

api.access

アクセストークンに対する使用許可を制御します。

api.access.deny(code, reason)

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

apiオブジェクトにリファレンスを返します。

パラメーター 説明
code

文字列。ログインの拒絶を判断するOAuthエラーコード。次のうちの一つです：'invalid_scope'、'invalid_request'、'server_error'

reason

文字列。アクセストークン付与を拒否するための人間が理解できる説明。

api.accessToken

発行されたアクセストークンを変更する要求。

api.accessToken.setCustomClaim(name, value)

この交換の一部として発行されるアクセストークンのカスタムクレームを設定します。

apiオブジェクトへの参照を返します。

パラメーター 説明
name

文字列。クレームの名前（これは完全修飾URLの必要がある場合があります）。

value

任意の値。クレームの値。

api.cache

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

api.cache.delete(key)

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

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

パラメーター 説明
key

文字列。キャッシュに保管されているレコードのキー。

api.cache.get(key)

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

提供されたkeyにキャッシュ済みの値が存在する場合は、それを記述したレコードを返します。キャッシュレコードは、キャッシュされた値のあるvalueプロパティと、レコードの最大有効期限をUNIXエポックからのミリ秒単位で示すexpires_atプロパティを持つオブジェクトです。

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

パラメーター 説明
key

文字列。キャッシュに保管されているレコードのキー。

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

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

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

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

パラメーター 説明
key

文字列。キャッシュに保管されているレコードのキー。
value

文字列。保管するレコードの値。
options

任意のオブジェクト。キャッシュの動作を調整するためのオプション。
options.expires_at

任意の数値。UNIXエポックからのミリ秒単位で指定した絶対有効期限。キャッシュ済みのレコードは早期に削除されることはあっても、expires_atで指定された時点を過ぎて存続することはありません。

注意：この値がttlで指定されている場合は指定するべきではありません。両方で指定された場合、2つの中で早い方の有効期限が適用されます。

options.ttl

任意の数値。このキャッシュエントリーのミリ秒単位で指定した存続時間。キャッシュ済みのレコードは早期に削除されることはあっても、ttlで指定された時点を過ぎて存続することはありません。

注意：この値がexpires_atで指定されている場合は指定するべきではありません。両方で指定された場合、2つの中で早い方の有効期限が適用されます。