@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.

@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.

@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.

@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.

@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.

@spec token_created_at_attribute_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the created_at attribute on this resource.

@spec token_created_at_attribute_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the created_at attribute on this resource.

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

The Ash domain to use to access this resource.

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

The Ash domain to use to access this resource.

@spec token_endpoints(dsl_or_extended :: module() | map()) ::
  {:ok, [module()]} | :error

The list of the endpoints where we will propagate the disconnect notification, when the user logs out or triggers log out from all devices.

@spec token_endpoints!(dsl_or_extended :: module() | map()) ::
  [module()] | no_return()

The list of the endpoints where we will propagate the disconnect notification, when the user logs out or triggers log out from all devices.

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

The name of the action used to remove expired tokens.

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

The name of the action used to remove expired tokens.

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

How often (in hours) to scan this resource for records which have expired and thus can be removed.

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

How often (in hours) to scan this resource for records which have expired and thus can be removed.

@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.

@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.

@spec token_live_socket_id_template(dsl_or_extended :: module() | map()) ::
  {:ok, (any() -> any())} | :error

A function that receives a map containing %{jti: jti} and returns the live socket ID string. Additional keys may be added in future versions.

@spec token_live_socket_id_template!(dsl_or_extended :: module() | map()) ::
  (any() -> any()) | no_return()

A function that receives a map containing %{jti: jti} and returns the live socket ID string. Additional keys may be added in future versions.

@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.

@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.

@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.

@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.

@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.

@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.

@spec token_revocation_revoke_all_stored_for_subject_action_name(
  dsl_or_extended :: module() | map()
) ::
  {:ok, atom()} | :error

The name of the action used to revoke all stored tokens for a given subject.

@spec token_revocation_revoke_all_stored_for_subject_action_name!(
  dsl_or_extended :: module() | map()
) ::
  atom() | no_return()

The name of the action used to revoke all stored tokens for a given subject.

@spec token_revocation_revoke_jti_action_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the action used to revoke jtis.

@spec token_revocation_revoke_jti_action_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the action used to revoke jtis.

@spec token_revocation_revoke_jti_insert_action_name(
  dsl_or_extended :: module() | map()
) ::
  {:ok, atom()} | :error

The name of the action used to insert a revocation record by JTI when the token was not previously stored. Non-upsert variant of revoke_jti.

@spec token_revocation_revoke_jti_insert_action_name!(
  dsl_or_extended :: module() | map()
) ::
  atom() | no_return()

The name of the action used to insert a revocation record by JTI when the token was not previously stored. Non-upsert variant of revoke_jti.

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

The name of the action used to revoke tokens.

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

The name of the action used to revoke tokens.

@spec token_revocation_revoke_token_insert_action_name(
  dsl_or_extended :: module() | map()
) ::
  {:ok, atom()} | :error

The name of the action used to insert a revocation record when the token was not previously stored. Unlike revoke_token, this action does not use upsert semantics, so concurrent duplicate revocations fail with a primary key conflict.

@spec token_revocation_revoke_token_insert_action_name!(
  dsl_or_extended :: module() | map()
) ::
  atom() | no_return()

The name of the action used to insert a revocation record when the token was not previously stored. Unlike revoke_token, this action does not use upsert semantics, so concurrent duplicate revocations fail with a primary key conflict.

@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.

@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.