AshAuthentication.AuditLogResource.Info (ash_authentication v4.13.3)

View Source

Introspection functions for the AshAuthentication.AuditLogResource Ash extension.

Summary

Functions

audit_log_attributes_action_name(dsl_or_extended)

The attribute within which to store the triggering action.

audit_log_attributes_action_name!(dsl_or_extended)

The attribute within which to store the triggering action.

audit_log_attributes_audit_log(dsl_or_extended)

The attribute within which to store the audit log add-on's name.

audit_log_attributes_audit_log!(dsl_or_extended)

The attribute within which to store the audit log add-on's name.

audit_log_attributes_extra_data(dsl_or_extended)

The attribute within which to store any additional information about the event.

audit_log_attributes_extra_data!(dsl_or_extended)

The attribute within which to store any additional information about the event.

audit_log_attributes_id(dsl_or_extended)

The name of the primary key attribute

audit_log_attributes_id!(dsl_or_extended)

The name of the primary key attribute

audit_log_attributes_logged_at(dsl_or_extended)

The attribute within which to store the time that the event occurred.

audit_log_attributes_logged_at!(dsl_or_extended)

The attribute within which to store the time that the event occurred.

audit_log_attributes_options(dsl_or_extended)

audit_log.attributes DSL options

audit_log_attributes_resource(dsl_or_extended)

The attribute within which to store the name of the affected resource.

audit_log_attributes_resource!(dsl_or_extended)

The attribute within which to store the name of the affected resource.

audit_log_attributes_status(dsl_or_extended)

The attribute within which to store the status of the event as defined by the authentication strategy.

audit_log_attributes_status!(dsl_or_extended)

The attribute within which to store the status of the event as defined by the authentication strategy.

audit_log_attributes_strategy(dsl_or_extended)

The attribute within which to store the authentication strategy's name.

audit_log_attributes_strategy!(dsl_or_extended)

The attribute within which to store the authentication strategy's name.

audit_log_attributes_subject(dsl_or_extended)

The attribute within which to store the user's authentication subject (if available).

audit_log_attributes_subject!(dsl_or_extended)

The attribute within which to store the user's authentication subject (if available).

audit_log_destroy_action_name(dsl_or_extended)

The name of the generated expunge action.

audit_log_destroy_action_name!(dsl_or_extended)

The name of the generated expunge action.

audit_log_destroy_action_options(dsl_or_extended)

audit_log.destroy_action DSL options

audit_log_domain(dsl_or_extended)

The Ash domain to use to access this resource.

audit_log_domain!(dsl_or_extended)

The Ash domain to use to access this resource.

audit_log_expunge_interval(dsl_or_extended)

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

audit_log_expunge_interval!(dsl_or_extended)

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

audit_log_log_lifetime(dsl_or_extended)

How long to keep event logs before removing them in days.

audit_log_log_lifetime!(dsl_or_extended)

How long to keep event logs before removing them in days.

audit_log_options(dsl_or_extended)

audit_log DSL options

audit_log_read_expired_action_name(dsl_or_extended)

The name of the generated read action.

audit_log_read_expired_action_name!(dsl_or_extended)

The name of the generated read action.

audit_log_read_expired_action_options(dsl_or_extended)

audit_log.read_expired_action DSL options

audit_log_write_action_name(dsl_or_extended)

The name of the generated write action.

audit_log_write_action_name!(dsl_or_extended)

The name of the generated write action.

audit_log_write_action_options(dsl_or_extended)

audit_log.write_action DSL options

audit_log_write_batching_enabled?(dsl_or_extended)

Whether or not write batching should be enabled. When set to false every event will be written to the log in it's own transaction.

audit_log_write_batching_max_size(dsl_or_extended)

Maximum number of events that can be written in a single batch.

audit_log_write_batching_max_size!(dsl_or_extended)

Maximum number of events that can be written in a single batch.

audit_log_write_batching_options(dsl_or_extended)

audit_log.write_batching DSL options

audit_log_write_batching_timeout(dsl_or_extended)

Maximum time to wait between writing batches in milliseconds.

audit_log_write_batching_timeout!(dsl_or_extended)

Maximum time to wait between writing batches in milliseconds.

Functions

audit_log_attributes_action_name(dsl_or_extended)

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

The attribute within which to store the triggering action.

audit_log_attributes_action_name!(dsl_or_extended)

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

The attribute within which to store the triggering action.

audit_log_attributes_audit_log(dsl_or_extended)

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

The attribute within which to store the audit log add-on's name.

audit_log_attributes_audit_log!(dsl_or_extended)

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

The attribute within which to store the audit log add-on's name.

audit_log_attributes_extra_data(dsl_or_extended)

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

The attribute within which to store any additional information about the event.

audit_log_attributes_extra_data!(dsl_or_extended)

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

The attribute within which to store any additional information about the event.

audit_log_attributes_id(dsl_or_extended)

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

The name of the primary key attribute

audit_log_attributes_id!(dsl_or_extended)

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

The name of the primary key attribute

audit_log_attributes_logged_at(dsl_or_extended)

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

The attribute within which to store the time that the event occurred.

audit_log_attributes_logged_at!(dsl_or_extended)

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

The attribute within which to store the time that the event occurred.

audit_log_attributes_options(dsl_or_extended)

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

audit_log.attributes DSL options

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

audit_log_attributes_resource(dsl_or_extended)

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

The attribute within which to store the name of the affected resource.

audit_log_attributes_resource!(dsl_or_extended)

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

The attribute within which to store the name of the affected resource.

audit_log_attributes_status(dsl_or_extended)

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

The attribute within which to store the status of the event as defined by the authentication strategy.

audit_log_attributes_status!(dsl_or_extended)

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

The attribute within which to store the status of the event as defined by the authentication strategy.

audit_log_attributes_strategy(dsl_or_extended)

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

The attribute within which to store the authentication strategy's name.

audit_log_attributes_strategy!(dsl_or_extended)

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

The attribute within which to store the authentication strategy's name.

audit_log_attributes_subject(dsl_or_extended)

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

The attribute within which to store the user's authentication subject (if available).

audit_log_attributes_subject!(dsl_or_extended)

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

The attribute within which to store the user's authentication subject (if available).

audit_log_destroy_action_name(dsl_or_extended)

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

The name of the generated expunge action.

audit_log_destroy_action_name!(dsl_or_extended)

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

The name of the generated expunge action.

audit_log_destroy_action_options(dsl_or_extended)

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

audit_log.destroy_action DSL options

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

audit_log_domain(dsl_or_extended)

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

The Ash domain to use to access this resource.

audit_log_domain!(dsl_or_extended)

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

The Ash domain to use to access this resource.

audit_log_expunge_interval(dsl_or_extended)

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

audit_log_expunge_interval!(dsl_or_extended)

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

audit_log_log_lifetime(dsl_or_extended)

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

How long to keep event logs before removing them in days.

audit_log_log_lifetime!(dsl_or_extended)

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

How long to keep event logs before removing them in days.

audit_log_options(dsl_or_extended)

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

audit_log DSL options

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

audit_log_read_expired_action_name(dsl_or_extended)

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

The name of the generated read action.

audit_log_read_expired_action_name!(dsl_or_extended)

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

The name of the generated read action.

audit_log_read_expired_action_options(dsl_or_extended)

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

audit_log.read_expired_action DSL options

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

audit_log_write_action_name(dsl_or_extended)

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

The name of the generated write action.

audit_log_write_action_name!(dsl_or_extended)

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

The name of the generated write action.

audit_log_write_action_options(dsl_or_extended)

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

audit_log.write_action DSL options

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

audit_log_write_batching_enabled?(dsl_or_extended)

@spec audit_log_write_batching_enabled?(dsl_or_extended :: module() | map()) ::
  boolean()

Whether or not write batching should be enabled. When set to false every event will be written to the log in it's own transaction.

audit_log_write_batching_max_size(dsl_or_extended)

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

Maximum number of events that can be written in a single batch.

audit_log_write_batching_max_size!(dsl_or_extended)

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

Maximum number of events that can be written in a single batch.

audit_log_write_batching_options(dsl_or_extended)

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

audit_log.write_batching DSL options

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

audit_log_write_batching_timeout(dsl_or_extended)

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

Maximum time to wait between writing batches in milliseconds.

audit_log_write_batching_timeout!(dsl_or_extended)

@spec audit_log_write_batching_timeout!(dsl_or_extended :: module() | map()) ::
  timeout() | no_return()

Maximum time to wait between writing batches in milliseconds.