frappe-role-manager

Frappe Role Manager Command

Comprehensive role and permission management for Frappe applications including role creation, permission assignment, and access control.

Steps to Execute

1. Verify Environment

• Check if in valid Frappe bench
• Verify site exists
• Ensure user has System Manager role

2. Operation Selection

Ask user what they want to do:

A. Create New Role

• Define role name
• Set role permissions
• Assign to users

B. Manage Permissions

• View permission matrix
• Add/remove permissions
• Set permission levels

C. Assign Roles to Users

• Add roles to user
• Remove roles from user
• View user roles

D. Test Permissions

• Test user access to DocType
• Verify permission rules
• Debug permission issues

3. Role Creation

Create New Role:

bench --site [site-name] console

# Create role
role = frappe.get_doc({
    'doctype': 'Role',
    'role_name': 'Custom Role',
    'desk_access': 1,  # Can access desk
    'disabled': 0
})
role.insert()
frappe.db.commit()

Role Properties:

• role_name: Unique role identifier
• desk_access: 1 = Can access desk, 0 = Portal only
• two_factor_auth: Require 2FA for this role
• disabled: 1 = Role disabled

4. Permission Management

Add Permissions to DocType:

# Via console
from frappe.permissions import add_permission

add_permission('Customer', 'Custom Role', perm_level=0)

# Set specific permissions
add_permission('Customer', 'Custom Role',
    read=1, write=1, create=1, delete=0,
    submit=0, cancel=0, amend=0)

frappe.db.commit()

View Permission Matrix:

# Get all permissions for DocType
permissions = frappe.get_all('Custom DocPerm',
    filters={'parent': 'Customer'},
    fields=['role', 'read', 'write', 'create', 'delete', 'submit']
)
print(permissions)

Remove Permissions:

from frappe.permissions import remove_permission

remove_permission('Customer', 'Custom Role')
frappe.db.commit()

5. User Role Assignment