Permify

View Source Permify.Permission (Permify v0.1.0)

Provides some functions to check the permissions.

Link to this section Summary

Types

action()
check_req()
depth()
entity()
subject()

Functions

check(client, request)

Check subject is authorized

check?(client, request)

Check subject is authorized

expand(client, request)

Expand relationships according to schema

Link to this section Types

Link to this type

action()

View Source 
@type action() :: binary()
Link to this type

check_req()

View Source 
@type check_req() :: %{
  :action => action(),
  optional(:depth) => depth(),
  :entity => entity(),
  optional(:schema_version) => Permify.schema_version(),
  subject: subject()
}
Link to this type

depth()

View Source 
@type depth() :: non_neg_integer()
Link to this type

entity()

View Source 
@type entity() :: Permify.Relationship.entity()
Link to this type

subject()

View Source 
@type subject() :: Permify.Relationship.subject()

Link to this section Functions

Link to this function

check(client, request)

View Source 
@spec check(Permify.Client.t(), check_req()) :: any()

Check subject is authorized

Link to this function

check?(client, request)

View Source 
@spec check?(Permify.Client.t(), check_req()) :: boolean()

Check subject is authorized

Link to this function

expand(client, request)

View Source 
@spec expand(Permify.Client.t(), any()) :: any()

Expand relationships according to schema