View Source AshAuthentication.TokenResource.Info (ash_authentication v4.0.0)

Introspection functions for the AshAuthentication.TokenResource Ash extension.

Summary

Functions

The name of the action used to get confirmation changes.

The name of the action used to get confirmation changes.

token.confirmation DSL options

The name of the action used to store confirmation changes.

The name of the action used to store confirmation changes.

The Ash domain to use to access this resource.

The Ash domain to use to access this resource.

The name of the action used to remove expired tokens.

The name of the action used to remove expired tokens.

How often to scan this resource for records which have expired, and thus can be removed.

How often to scan this resource for records which have expired, and thus can be removed.

The name of the action used to retrieve tokens from the store, if require_tokens_for_authentication? is enabled in your authentication resource.

The name of the action used to retrieve tokens from the store, if require_tokens_for_authentication? is enabled in your authentication resource.

token DSL options

The name of the action use to find all expired tokens.

The name of the action use to find all expired tokens.

The name of the action used to check if a token is revoked.

The name of the action used to check if a token is revoked.

token.revocation DSL options

The name of the action used to revoke tokens.

The name of the action used to revoke tokens.

The name of the action to use to store a token, if require_tokens_for_authentication? is enabled in your authentication resource.

The name of the action to use to store a token, if require_tokens_for_authentication? is enabled in your authentication resource.

Functions

Link to this function

token_confirmation_get_changes_action_name(dsl_or_extended)

View Source
@spec token_confirmation_get_changes_action_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the action used to get confirmation changes.

Link to this function

token_confirmation_get_changes_action_name!(dsl_or_extended)

View Source
@spec token_confirmation_get_changes_action_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the action used to get confirmation changes.

Link to this function

token_confirmation_options(dsl_or_extended)

View Source
@spec token_confirmation_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

token.confirmation DSL options

Returns a map containing the and any configured or default values.

Link to this function

token_confirmation_store_changes_action_name(dsl_or_extended)

View Source
@spec token_confirmation_store_changes_action_name(
  dsl_or_extended :: module() | map()
) ::
  {:ok, atom()} | :error

The name of the action used to store confirmation changes.

Link to this function

token_confirmation_store_changes_action_name!(dsl_or_extended)

View Source
@spec token_confirmation_store_changes_action_name!(
  dsl_or_extended :: module() | map()
) ::
  atom() | no_return()

The name of the action used to store confirmation changes.

Link to this function

token_domain(dsl_or_extended)

View Source
@spec token_domain(dsl_or_extended :: module() | map()) :: {:ok, module()} | :error

The Ash domain to use to access this resource.

Link to this function

token_domain!(dsl_or_extended)

View Source
@spec token_domain!(dsl_or_extended :: module() | map()) :: module() | no_return()

The Ash domain to use to access this resource.

Link to this function

token_expunge_expired_action_name(dsl_or_extended)

View Source
@spec token_expunge_expired_action_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the action used to remove expired tokens.

Link to this function

token_expunge_expired_action_name!(dsl_or_extended)

View Source
@spec token_expunge_expired_action_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the action used to remove expired tokens.

Link to this function

token_expunge_interval(dsl_or_extended)

View Source
@spec token_expunge_interval(dsl_or_extended :: module() | map()) ::
  {:ok, pos_integer()} | :error

How often to scan this resource for records which have expired, and thus can be removed.

Link to this function

token_expunge_interval!(dsl_or_extended)

View Source
@spec token_expunge_interval!(dsl_or_extended :: module() | map()) ::
  pos_integer() | no_return()

How often to scan this resource for records which have expired, and thus can be removed.

Link to this function

token_get_token_action_name(dsl_or_extended)

View Source
@spec token_get_token_action_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the action used to retrieve tokens from the store, if require_tokens_for_authentication? is enabled in your authentication resource.

Link to this function

token_get_token_action_name!(dsl_or_extended)

View Source
@spec token_get_token_action_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the action used to retrieve tokens from the store, if require_tokens_for_authentication? is enabled in your authentication resource.

Link to this function

token_options(dsl_or_extended)

View Source
@spec token_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

token DSL options

Returns a map containing the and any configured or default values.

Link to this function

token_read_expired_action_name(dsl_or_extended)

View Source
@spec token_read_expired_action_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the action use to find all expired tokens.

Link to this function

token_read_expired_action_name!(dsl_or_extended)

View Source
@spec token_read_expired_action_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the action use to find all expired tokens.

Link to this function

token_revocation_is_revoked_action_name(dsl_or_extended)

View Source
@spec token_revocation_is_revoked_action_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the action used to check if a token is revoked.

Link to this function

token_revocation_is_revoked_action_name!(dsl_or_extended)

View Source
@spec token_revocation_is_revoked_action_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the action used to check if a token is revoked.

Link to this function

token_revocation_options(dsl_or_extended)

View Source
@spec token_revocation_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

token.revocation DSL options

Returns a map containing the and any configured or default values.

Link to this function

token_revocation_revoke_token_action_name(dsl_or_extended)

View Source
@spec token_revocation_revoke_token_action_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the action used to revoke tokens.

Link to this function

token_revocation_revoke_token_action_name!(dsl_or_extended)

View Source
@spec token_revocation_revoke_token_action_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the action used to revoke tokens.

Link to this function

token_store_token_action_name(dsl_or_extended)

View Source
@spec token_store_token_action_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the action to use to store a token, if require_tokens_for_authentication? is enabled in your authentication resource.

Link to this function

token_store_token_action_name!(dsl_or_extended)

View Source
@spec token_store_token_action_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the action to use to store a token, if require_tokens_for_authentication? is enabled in your authentication resource.