Rajska v1.3.2

Rajska.Authorization behaviour (Rajska v1.3.2) View Source

Behaviour of an Authorization module.

Link to this section Summary

Types

context()
current_user()
current_user_role()
role()
rule()
scoped_struct()

Callbacks

context_role_authorized?(context, allowed_role)
context_user_authorized?(context, scoped_struct, rule)
get_current_user(context)
get_ip(context)
get_user_role(current_user)
has_user_access?(current_user, scoped_struct, rule)
not_scoped_roles()
role_authorized?(current_user_role, allowed_role)
unauthorized_field_message(resolution, atom)
unauthorized_message(resolution)
unauthorized_object_message(resolution, arg2)
unauthorized_object_scope_message(object_result, atom)
unauthorized_query_scope_message(resolution, atom)

Link to this section Types

Link to this type

context()

View Source

Specs

context() :: map()
Link to this type

current_user()

View Source

Specs

current_user() :: any()
Link to this type

current_user_role()

View Source

Specs

current_user_role() :: role()
Link to this type

role()

View Source

Specs

role() :: atom()
Link to this type

rule()

View Source

Specs

rule() :: atom()
Link to this type

scoped_struct()

View Source

Specs

scoped_struct() :: struct()

Link to this section Callbacks

Link to this callback

context_role_authorized?(context, allowed_role)

View Source (optional)

Specs

context_role_authorized?(context(), allowed_role :: role()) :: boolean()
Link to this callback

context_user_authorized?(context, scoped_struct, rule)

View Source (optional)

Specs

context_user_authorized?(context(), scoped_struct(), rule()) :: boolean()
Link to this callback

get_current_user(context)

View Source (optional)

Specs

get_current_user(context()) :: current_user()
Link to this callback

get_ip(context)

View Source (optional)

Specs

get_ip(context()) :: String.t()
Link to this callback

get_user_role(current_user)

View Source (optional)

Specs

get_user_role(current_user()) :: role()
Link to this callback

has_user_access?(current_user, scoped_struct, rule)

View Source (optional)

Specs

has_user_access?(current_user(), scoped_struct(), rule()) :: boolean()
Link to this callback

not_scoped_roles()

View Source (optional)

Specs

not_scoped_roles() :: [role()]
Link to this callback

role_authorized?(current_user_role, allowed_role)

View Source (optional)

Specs

role_authorized?(current_user_role(), allowed_role :: role()) :: boolean()
Link to this callback

unauthorized_field_message(resolution, atom)

View Source (optional)

Specs

unauthorized_field_message(resolution :: Absinthe.Resolution.t(), atom()) ::
  String.t()
Link to this callback

unauthorized_message(resolution)

View Source (optional)

Specs

unauthorized_message(resolution :: Absinthe.Resolution.t()) ::
  String.t() | map() | list()
Link to this callback

unauthorized_object_message(resolution, arg2)

View Source (optional)

Specs

unauthorized_object_message(
  resolution :: Absinthe.Resolution.t(),
  Absinthe.Type.Object.t()
) ::
  String.t()
Link to this callback

unauthorized_object_scope_message(object_result, atom)

View Source (optional)

Specs

unauthorized_object_scope_message(
  object_result :: Absinthe.Blueprint.Result.Object.t(),
  atom()
) ::
  String.t()
Link to this callback

unauthorized_query_scope_message(resolution, atom)

View Source (optional)

Specs

unauthorized_query_scope_message(resolution :: Absinthe.Resolution.t(), atom()) ::
  String.t()