LoginRadius v1.0.0 LoginRadius.RolesManagement View Source

Elixir wrapper for the LoginRadius Roles Management API module

Link to this section Summary

Functions

PUT - Add Permissions to Role: Adds permissions to a given role. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/add-permissions-to-role

PUT - Assign Roles by UID: Assigns created roles to a user. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/assign-roles-by-uid

DELETE - Delete Additional Permissions from Context Deletes additional permissions from context. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/delete-permissions-from-context

DELETE - Delete Role: Deletes a role given a role name. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/delete-role

DELETE - Delete Role Context: Deletes a specified role context given UID and role context name. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/delete-context

DELETE - Delete Role from Context Deletes a specified role from a context. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/delete-role-from-context

GET - Get Context with Roles and Permissions: Retrieves the contexts which have been configured for a user and its associated roles and permissions. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/get-context

DELETE - Remove Permissions: Removes permissions from a role. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/remove-permissions

GET - Roles by UID: Retrieves all assigned roles of a particular user by uid. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/get-roles-by-uid

POST - Roles Create: Creates roles with permissions. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/roles-create

GET - Roles List: Retrieves complete list of created roles with permissions of your app. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/roles-list

DELETE - Unassign Roles by UID: Unassigns roles from a user given uid. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/unassign-roles-by-uid

PUT - Upsert Context: Creates a context with a set of roles. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/upsert-context

Link to this section Functions

Link to this function add_permissions_to_role(role_name, data) View Source
add_permissions_to_role(String.t(), map()) :: LoginRadius.response()

PUT - Add Permissions to Role: Adds permissions to a given role. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/add-permissions-to-role

Link to this function assign_roles_by_uid(uid, data) View Source
assign_roles_by_uid(String.t(), map()) :: LoginRadius.response()

PUT - Assign Roles by UID: Assigns created roles to a user. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/assign-roles-by-uid

Link to this function delete_additional_permissions_from_context(uid, role_context_name, data) View Source
delete_additional_permissions_from_context(String.t(), String.t(), map()) ::
  LoginRadius.response()

DELETE - Delete Additional Permissions from Context Deletes additional permissions from context. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/delete-permissions-from-context

Link to this function delete_role(role_name) View Source
delete_role(String.t()) :: LoginRadius.response()

DELETE - Delete Role: Deletes a role given a role name. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/delete-role

Link to this function delete_role_context(uid, role_context_name) View Source
delete_role_context(String.t(), String.t()) :: LoginRadius.response()

DELETE - Delete Role Context: Deletes a specified role context given UID and role context name. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/delete-context

Link to this function delete_role_from_context(uid, role_context_name, data) View Source
delete_role_from_context(String.t(), String.t(), map()) ::
  LoginRadius.response()

DELETE - Delete Role from Context Deletes a specified role from a context. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/delete-role-from-context

GET - Get Context with Roles and Permissions: Retrieves the contexts which have been configured for a user and its associated roles and permissions. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/get-context

Link to this function remove_permissions(role_name, data) View Source
remove_permissions(String.t(), map()) :: LoginRadius.response()

DELETE - Remove Permissions: Removes permissions from a role. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/remove-permissions

GET - Roles by UID: Retrieves all assigned roles of a particular user by uid. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/get-roles-by-uid

Link to this function roles_create(data) View Source
roles_create(map()) :: LoginRadius.response()

POST - Roles Create: Creates roles with permissions. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/roles-create

GET - Roles List: Retrieves complete list of created roles with permissions of your app. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/roles-list

Link to this function unassign_roles_by_uid(uid, data) View Source
unassign_roles_by_uid(String.t(), map()) :: LoginRadius.response()

DELETE - Unassign Roles by UID: Unassigns roles from a user given uid. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/unassign-roles-by-uid

Link to this function upsert_context(uid, data) View Source
upsert_context(String.t(), map()) :: LoginRadius.response()

PUT - Upsert Context: Creates a context with a set of roles. https://docs.loginradius.com/api/v2/customer-identity-api/roles-management/upsert-context