SecureX.Permissions (SecureX v0.2.0) View Source

Contains CRUD For Permissions.

Link to this section Summary

Functions

Add a Permission. You can send either Atom Map or String Map to add 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 Permission.

Link to this section Functions

Specs

add(map()) :: struct()

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

Examples

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

Specs

delete(map()) :: struct()

Delete a Permission.

Examples

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

Specs

list(list()) :: [...]

Get list of Permissions by User Roles

Examples

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

]9

Specs

update(map()) :: struct()

Update a Permission. You can send either Atom Map or String Map to update 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"
}