Version 6.x.x Source

frappe.permissions.add_user_permission (doctype, name, user, with_message=False)

No docs


frappe.permissions.apply_user_permissions (doctype, ptype, user=None)

Check if applyuserpermissions is checked for a doctype, perm type, user combination


frappe.permissions.can_export (doctype, raise_exception=False)

No docs


frappe.permissions.can_import (doctype, raise_exception=False)

No docs


frappe.permissions.can_set_user_permissions (doctype, docname=None)

No docs


frappe.permissions.check_admin_or_system_manager (user=None)

No docs


frappe.permissions.clear_user_permissions_for_doctype (doctype)

No docs


frappe.permissions.get_doc_permissions (doc, verbose=False, user=None)

Returns a dict of evaluated permissions for given doc like {"read":1, "write":1}


frappe.permissions.get_linked_doctypes (dt)

No docs


frappe.permissions.get_role_permissions (meta, user=None, verbose=False)

Returns dict of evaluated role permissions like {"read": True, "write":False}

If user permissions are applicable, it adds a dict of user permissions like

{
    // user permissions will apply on these rights
    "apply_user_permissions": {"read": 1, "write": 1},

    // doctypes that will be applicable for each right
    "user_permission_doctypes": {
        "read": [
            // AND between "DocType 1" and "DocType 2"
            ["DocType 1", "DocType 2"],

            // OR

            ["DocType 3"]

        ]
    }

    "if_owner": {"read": 1, "write": 1}
}

frappe.permissions.get_user_permission_doctypes (user_permission_doctypes, user_permissions)

returns a list of list like [["User", "Blog Post"], ["User"]]


frappe.permissions.has_controller_permissions (doc, ptype, user=None)

Returns controller permissions if defined. None if not defined


frappe.permissions.has_permission (doctype, ptype=read, doc=None, verbose=False, user=None)

Returns True if user has permission ptype for given doctype. If doc is passed, it also checks user, share and owner permissions.

Note: if Table DocType is passed, it always returns True.


frappe.permissions.remove_user_permission (doctype, name, user, default_value_name=None)

No docs


frappe.permissions.reset_perms (doctype)

Reset permissions for given doctype.


frappe.permissions.set_user_permission_if_allowed (doctype, name, user, with_message=False)

No docs


frappe.permissions.update_share_permissions (role_permissions, doc, user)

Updates share permissions on role_permissions for given doc, if shared


frappe.permissions.user_has_permission (doc, verbose=True, user=None, user_permission_doctypes=None)

No docs