Ash.Policy.Policy (ash v3.7.6)

View Source

Represents a policy on an Ash.Resource

Summary

Types

t()

Functions

expression(policies, check_context)
fetch_fact(facts, check)
fetch_or_strict_check_fact(authorizer, check)
scenario_options(check_context)

Default Options for Crux scenarios

solve(authorizer)

Types

t()

@type t() :: %Ash.Policy.Policy{
  __spark_metadata__: Spark.Dsl.Entity.spark_meta(),
  access_type: :strict | :filter | :runtime,
  bypass?: boolean(),
  condition: nil | Ash.Policy.Check.ref() | [Ash.Policy.Check.ref()],
  description: String.t() | nil,
  policies: [Ash.Policy.Check.t()]
}

Functions

expression(policies, check_context)

@spec expression(
  policies ::
    t() | Ash.Policy.FieldPolicy.t() | [t() | Ash.Policy.FieldPolicy.t()],
  check_context :: Ash.Policy.Check.context()
) :: Crux.Expression.t(Ash.Policy.Check.ref())

fetch_fact(facts, check)

@spec fetch_fact(
  facts :: map(),
  check :: Ash.Policy.Check.t() | Ash.Policy.Check.ref()
) ::
  {:ok, Crux.Expression.t(Ash.Policy.Check.ref())} | :error

fetch_or_strict_check_fact(authorizer, check)

@spec fetch_or_strict_check_fact(
  Ash.Policy.Authorizer.t(),
  Ash.Policy.Check.t() | Ash.Policy.Check.ref()
) ::
  {:ok, Crux.Expression.t(Ash.Policy.Check.ref()), Ash.Policy.Authorizer.t()}
  | {:error, Ash.Policy.Authorizer.t()}

scenario_options(check_context)

@spec scenario_options(check_context :: Ash.Policy.Check.context()) ::
  Crux.opts(Ash.Policy.Check.ref())

Default Options for Crux scenarios

solve(authorizer)

@spec solve(authorizer :: Ash.Policy.Authorizer.t()) ::
  {:ok, boolean() | [map()], Ash.Policy.Authorizer.t()}
  | {:error, Ash.Policy.Authorizer.t(), Ash.Error.t()}