Spear v1.4.0

View Source Spear.Acl (Spear v1.4.0)

A struct representing an access control list (ACL)

See the Security guide for more information on ACLs

Link to this section Summary

Types

t()

An access control list (ACL) type

Functions

admins_only()

Produces an ACL that only allows access to all resources to the $admins group

allow_all()

Produces an ACL that allows all users access to all resources

to_map(acl)

Converts an ACL struct to a map with the keys expected by the EventStoreDB

Link to this section Types

Link to this type

t()

View Source (since 1.3.0) 
@type t() :: %Spear.Acl{
  delete: String.t() | [String.t()],
  metadata_read: String.t() | [String.t()],
  metadata_write: String.t() | [String.t()],
  read: String.t() | [String.t()],
  write: String.t() | [String.t()]
}

An access control list (ACL) type

See the Security guide for more information on ACLs

ACLs may provide permissions for a single user/group or a list of user/groups.

examples

 Examples 

iex> Spear.Acl.allow_all()
%Spear.Acl{
  delete: "$all",
  metadata_read: "$all",
  metadata_write: "$all",
  read: "$all",
  write: "$all"
}

Link to this section Functions

Link to this function

admins_only()

View Source

Produces an ACL that only allows access to all resources to the $admins group

examples

 Examples 

iex> Spear.Acl.admins_only()
%Spear.Acl{
  delete: "$admins",
  metadata_read: "$admins",
  metadata_write: "$admins",
  read: "$admins",
  write: "$admins"
}
Link to this function

allow_all()

View Source

Produces an ACL that allows all users access to all resources

Note that clients that do not provide credentials at all fall under the $all group.

examples

 Examples 

iex> Spear.Acl.allow_all()
%Spear.Acl{
  delete: "$all",
  metadata_read: "$all",
  metadata_write: "$all",
  read: "$all",
  write: "$all"
}
Link to this function

to_map(acl)

View Source (since 0.1.3) 
@spec to_map(t()) :: %{required(String.t()) => String.t() | [String.t()]}

Converts an ACL struct to a map with the keys expected by the EventStoreDB

This function is used internally by Spear.set_global_acl/4 to create a global ACL event body, but may be used to create an acl body on its own.

examples

 Examples 

iex> Spear.Acl.allow_all() |> Spear.Acl.to_map()
%{
  "$w" => "$all",
  "$r" => "$all",
  "$d" => "$all",
  "$mw" => "$all",
  "$mr" => "$all"
}