AuthShield v0.0.1 AuthShield.Resources.Permissions View Source
Permissions are used to define what a set of roles can do in the system.
We use this to implement and Role-based access control (RBAC).
RBAC is a policy-neutral access-control mechanism defined around roles and privileges.
The components of RBAC such as role-permissions and user-role relationships make it simple to perform user assignments.
This module implements an interface to deal with database transactions as inserts, updates, deletes, etc.
Link to this section Summary
Functions
Deletes a AuthShield.Resources.Schemas.Permission
register.
Deletes a AuthShield.Resources.Schemas.Permission
register.
Gets a AuthShield.Resources.Schemas.Permission
register by its filters.
Gets a AuthShield.Resources.Schemas.Permission
register by its filters.
Creates a new AuthShield.Resources.Schemas.Permission
register.
Creates a new AuthShield.Resources.Schemas.Permission
register.
Returns a list of AuthShield.Resources.Schemas.Permission
by its filters
Updates a AuthShield.Resources.Schemas.Permission
register.
Updates a AuthShield.Resources.Schemas.Permission
register.
Link to this section Types
Transactional responses of failed
success_response()
View Sourcesuccess_response() :: {:ok, AuthShield.Resources.Schemas.Permission.t()}
Transactional responses of success
Link to this section Functions
delete(permission)
View Sourcedelete(permission :: AuthShield.Resources.Schemas.Permission.t()) :: success_response() | failed_response()
Deletes a AuthShield.Resources.Schemas.Permission
register.
Exemples:
AuthShield.Resources.Permissions.delete(permission)
delete!(permission)
View Sourcedelete!(permission :: AuthShield.Resources.Schemas.Permission.t()) :: AuthShield.Resources.Schemas.Permission.t() | no_return()
Deletes a AuthShield.Resources.Schemas.Permission
register.
Similar to delete/1
but returns the struct or raises if the changeset is invalid.
get_by(filters)
View Sourceget_by(filters :: keyword()) :: AuthShield.Resources.Schemas.Permission.t() | nil
Gets a AuthShield.Resources.Schemas.Permission
register by its filters.
Exemples:
AuthShield.Resources.Permissions.get_by(name: "can_create_users")
get_by!(filters)
View Sourceget_by!(filters :: keyword()) :: AuthShield.Resources.Schemas.Permission.t() | no_return()
Gets a AuthShield.Resources.Schemas.Permission
register by its filters.
Similar to get_by/1
but returns the struct or raises if the changeset is invalid.
insert(params)
View Sourceinsert(params :: map()) :: success_response() | failed_response()
Creates a new AuthShield.Resources.Schemas.Permission
register.
Exemples:
AuthShield.Resources.Permissions.insert(%{
name: "can_create_users",
description: "Has permission to create users on the system"
})
insert!(params)
View Sourceinsert!(params :: map()) :: AuthShield.Resources.Schemas.Permission.t() | no_return()
Creates a new AuthShield.Resources.Schemas.Permission
register.
Similar to insert/1
but returns the struct or raises if the changeset is invalid.
list(filters \\ [])
View Sourcelist(filters :: keyword()) :: [AuthShield.Resources.Schemas.Permission.t()]
Returns a list of AuthShield.Resources.Schemas.Permission
by its filters
Exemples:
# Getting the all list
AuthShield.Resources.Permissions.list()
# Filtering the list by field
AuthShield.Resources.Permissions.list(name: "can_create_users")
update(permission, params)
View Sourceupdate( permission :: AuthShield.Resources.Schemas.Permission.t(), params :: map() ) :: success_response() | failed_response()
Updates a AuthShield.Resources.Schemas.Permission
register.
Exemples:
AuthShield.Resources.Permissions.update(permission, %{
name: "can_update_users",
description: "Has permission to update users on the system"
})
update!(permission, params)
View Sourceupdate!( permission :: AuthShield.Resources.Schemas.Permission.t(), params :: map() ) :: AuthShield.Resources.Schemas.Permission.t() | no_return()
Updates a AuthShield.Resources.Schemas.Permission
register.
Similar to update/2
but returns the struct or raises if the changeset is invalid.