Ash.Authorizer behaviour (ash v1.37.2) View Source

The interface for an ash authorizer

These will typically be implemented by an extension, but a custom one can be implemented by defining a module that adopts this behaviour and using @authorizers YourAuthorizer to your resource.

Link to this section Summary

Types

context()

state()

Functions

check(module, state, context)

check_context(module, state)

initial_state(module, actor, resource, action, verbose?)

strict_check(module, state, context)

strict_check_context(module, state)

Callbacks

check(state, context)

check_context(state)

initial_state(arg1, arg2, arg3, boolean)

strict_check(state, context)

strict_check_context(state)

Link to this section Types

context()

Specs

context() :: map()

state()

Specs

state() :: map()

Link to this section Functions

check(module, state, context)

check_context(module, state)

initial_state(module, actor, resource, action, verbose?)

strict_check(module, state, context)

strict_check_context(module, state)

Link to this section Callbacks

check(state, context)

Specs

check(state(), context()) ::
  :authorized | {:data, [Ash.Resource.record()]} | {:error, term()}

check_context(state)

Specs

check_context(state()) :: [atom()]

initial_state(arg1, arg2, arg3, boolean)

Specs

initial_state(
  Ash.Resource.t(),
  Ash.Resource.record(),
  Ash.Resource.Actions.action(),
  boolean()
) :: state()

strict_check(state, context)

Specs

strict_check(state(), context()) ::
  :authorized
  | {:continue, state()}
  | {:filter, Keyword.t()}
  | {:filter_and_continue, Keyword.t(), state()}
  | {:error, term()}

strict_check_context(state)

Specs

strict_check_context(state()) :: [atom()]