ash

v0.1.1

ash v0.1.1 Ash.Authorization.Check behaviour View Source

A behaviour for declaring checks, which can be used to easily construct authorization rules.

Link to this section Summary

Types

options()

Callbacks

check(arg1, arg2, arg3, options)
describe(options)
init(options)
precheck(arg1, arg2, options)

Link to this section Types

Link to this type

options()

View Source 
options() :: Keyword.t()

Link to this section Callbacks

Link to this callback

check(arg1, arg2, arg3, options)

View Source 
check(
  Ash.Authorization.Rule.user(),
  Ash.Authorization.Rule.data(),
  Ash.Authorization.Rule.context(),
  options()
) :: Ash.Authorization.Rule.resource_ids()
Link to this callback

describe(options)

View Source 
describe(options()) :: String.t()
Link to this callback

init(options)

View Source 
init(options()) :: {:ok, options()} | {:error, String.t()}
Link to this callback

precheck(arg1, arg2, options)

View Source (optional) 
precheck(
  Ash.Authorization.Rule.user(),
  Ash.Authorization.Rule.context(),
  options()
) ::
  Ash.Authorization.Rule.precheck_result()
  | [Ash.Authorization.Rule.precheck_result()]