API Object

Learn about the post-change-password Action trigger’s API object.

The API object for the post-change-password Actions trigger exposes methods for managing the cache.

api.cache

Store and retrieve data that persists across executions.

api.cache.delete(key) · void

Delete a cached record at the supplied key if it exists.

Example

exports.onExecutePostChangePassword = async (event, api) => {
  api.cache.delete('my-key');
};

Parameters

Show Parameters

key · string

The key of the cache record to delete.

api.cache.get(key) · object | undefined

Retrieve a cached record at the supplied key. If found, access the value via record.value.

Example

exports.onExecutePostChangePassword = async (event, api) => {
  const record = api.cache.get('my-key');
  if (record) console.log(record.value);
};

Parameters

Show Parameters

key · string

The key of the record stored in the cache.

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

Store or update a string value in the cache at the specified key. Values are scoped to the Trigger and subject to the Actions Cache Limits. If no lifetime is specified, a default lifetime of 15 minutes will be used.

Important: This cache is designed for short-lived, ephemeral data. Items may not be available in later transactions even if they are within their supplied lifetime.

Example

exports.onExecutePostChangePassword = async (event, api) => {
  api.cache.set('my-key', 'my-value', { ttl: 60000 });
};

Parameters

Show Parameters

key · string

The key of the record to be stored.

value · string

The value of the record to be stored.

options · CacheSetOptions

Options for adjusting cache behavior. Optional.

Show options properties

expires_at · number

The absolute expiry time in milliseconds since the unix epoch. Note: Do not supply if ttl is also provided; the earlier expiry will be used.

ttl · number

The time-to-live in milliseconds. Note: Do not supply if expires_at is also provided; the earlier expiry will be used.