View Source SecureX.Permissions (SecureX v1.0.2)

Contains CRUD For Permissions.

Link to this section Summary

Functions

Add a Permission. You can send either Atom Map or String Map to add a Permission.

Delete a Permission.

Get list of Permissions by User Roles.

Update a Permission. You can send either Atom Map or String Map to update a Permission.

Link to this section Functions

@spec add(map()) :: tuple()

Add a Permission. You can send either Atom Map or String Map to add a Permission.

examples

Examples

iex> add(%{"permission" => -1, "resource_id" => "users", "role_id" => "super_admin"})
%Permission{
  id: 1,
  permission: -1,
  resource_id: "users",
  role_id: "super_admin"
}
@spec delete(map()) :: tuple()

Delete a Permission.

examples

Examples

iex> delete(%{"id" => 1)
%Permission{
  id: 1,
  permission: 4,
  resource_id: "users",
  role_id: "admin"
}
Link to this function

list(params, page, page_size \\ 10)

View Source
@spec list(list(), number(), number()) :: tuple()

Get list of Permissions by User Roles.

examples

Examples

iex> list(["owner", "super_admin"])
[
%{ permission: 4, resource_id: "users", role_id: "admin"},
%{ permission: 4, resource_id: "person_form", role_id: "super_admin"}

]

@spec update(map()) :: tuple()

Update a Permission. You can send either Atom Map or String Map to update a Permission.

## Examples

iex> update(%{"id" => "1", "resource_id" => "users", "permission" => 4, "role_id" => "admin"})
%Permission{
  id: 1,
  permission: 4,
  resource_id: "users",
  role_id: "admin"
}