View Source DSL: AshAuthentication.TokenResource

This is an Ash resource extension which generates the default token resource.

The token resource is used to store information about tokens that should not be shared with the end user. It does not actually contain any tokens.

For example:

  • When an authentication token has been revoked
  • When a confirmation token has changes to apply


The information stored in this resource is essentially ephemeral - all tokens have an expiry date, so it doesn't make sense to keep them after that time has passed. However, if you have any tokens with very long expiry times then we suggest you store this resource in a resilient data-layer such as Postgres.


There is no need to define any attributes or actions (although you can if you want). The extension will wire up everything that's needed for the token system to function.

defmodule MyApp.Accounts.Token do
  use Ash.Resource,
    data_layer: AshPostgres.DataLayer,
    extensions: [AshAuthentication.TokenResource],
    domain: MyApp.Accounts

  postgres do
    table "tokens"
    repo MyApp.Repo

Whilst it is possible to have multiple token resources, there is no need to do so.

Removing expired records

Once a token has expired there's no point in keeping the information it refers to, so expired tokens can be automatically removed by adding the AshAuthentication.Supervisor to your application supervision tree. This will start the AshAuthentication.TokenResource.Expunger GenServer which periodically scans and removes any expired records.


Configuration options for this token resource

Nested DSLs


domainmoduleThe Ash domain to use to access this resource.
expunge_expired_action_nameatom:expunge_expiredThe name of the action used to remove expired tokens.
read_expired_action_nameatom:read_expiredThe name of the action use to find all expired tokens.
expunge_intervalpos_integer12How often to scan this resource for records which have expired, and thus can be removed.
store_token_action_nameatom:store_tokenThe name of the action to use to store a token, if require_tokens_for_authentication? is enabled in your authentication resource.
get_token_action_nameatom:get_tokenThe name of the action used to retrieve tokens from the store, if require_tokens_for_authentication? is enabled in your authentication resource.


Configuration options for token revocation


revoke_token_action_nameatom:revoke_tokenThe name of the action used to revoke tokens.
is_revoked_action_nameatom:revoked?The name of the action used to check if a token is revoked.


Configuration options for confirmation tokens


store_changes_action_nameatom:store_confirmation_changesThe name of the action used to store confirmation changes.
get_changes_action_nameatom:get_confirmation_changesThe name of the action used to get confirmation changes.