--- name: frappe-secure-endpoint-ea4c42f2e857 description: Generate secure, tenant-aware API endpoints with authentication and tenant isolation. --- # Generate Secure Endpoint Create secure API endpoints with automatic authentication and tenant isolation. ## When to Use - Creating custom API endpoints - Need tenant-aware data access - Implementing business logic beyond CRUD - Creating aggregated endpoints ## Core Patterns ### 1. Basic Secure Endpoint ```python @app.secure_route('/endpoint', methods=['GET']) def handler(user): tenant_id = get_current_tenant_id() app.set_tenant_id(tenant_id) data = app.tenant_db.get_all('DocType', filters={...}) return {"data": data} ``` ### 2. POST with Validation ```python @app.secure_route('/endpoint', methods=['POST']) def create_handler(user): data = request.json if not data or not data.get('required_field'): return {"error": "required_field is required"}, 400 tenant_id = get_current_tenant_id() app.set_tenant_id(tenant_id) try: frappe.db.begin() doc = app.tenant_db.insert_doc('DocType', data) app.tenant_db.commit() return {"success": True, "data": doc.as_dict()}, 201 except Exception as e: app.tenant_db.rollback() return {"error": str(e)}, 500 ``` ### 3. GET with Query Parameters ```python @app.secure_route('/endpoint', methods=['GET']) def list_handler(user): tenant_id = get_current_tenant_id() app.set_tenant_id(tenant_id) page = int(request.args.get('page', 1)) limit = int(request.args.get('limit', 20)) status = request.args.get('status') filters = {'status': status} if status else {} data = app.tenant_db.get_all('DocType', filters=filters, limit_page_length=limit, limit_start=(page-1)*limit) return {"data": data, "page": page, "limit": limit} ``` ### 4. PUT/DELETE ```python @app.secure_route('/endpoint/', methods=['PUT']) def update_handler(user, name): tenant_id = get_current_tenant_id() app.set_tenant_id(tenant_id) doc = app.tenant_db.get_doc('DocType', name) doc.update(request.json) doc.save() app.tenant_db.commit() return {"success": True, "data": doc.as_dict()} @app.secure_route('/endpoint/', methods=['DELETE']) def delete_handler(user, name): tenant_id = get_current_tenant_id() app.set_tenant_id(tenant_id) doc = app.tenant_db.get_doc('DocType', name) doc.delete() app.tenant_db.commit() return {"success": True} ``` ## Key Patterns 1. Always use `@app.secure_route` (never `@app.route`) 2. Set tenant_id first with `app.set_tenant_id()` 3. Use `app.tenant_db` (never `frappe.db`) 4. Use transactions for multi-step operations 5. Return proper HTTP status codes 6. Validate input before processing ## Best Practices - Always authenticate with `@app.secure_route` - Set tenant_id before database operations - Use tenant_db for all queries - Handle errors gracefully - Use transactions for multi-step operations Remember: This skill is model-invoked. Claude will use it autonomously when detecting secure endpoint development needs. ## Decision Tree & Reference *Condensed from `frappe-core-permissions` (Frappe_Claude_Skill_Package): Frappe-native access control aligns with secure, user-facing endpoints.* ### Permission decision tree ``` Need access control? ├── Who can CRUD/submit/etc. on DocType? → Role Permissions on DocType ├── Which concrete records visible? → User Permissions (record-level filters on Link targets) ├── Which fields readable/editable? → Perm Levels (permlevel ≥ 1; grant 0 before higher levels) ├── Field values masked [v16+]? → Field mask + grant `mask` on role rows ├── Custom deny-only logic? → has_permission hook ├── Narrow list/query results before return? → permission_query_conditions hook └── One-off sharing? → frappe.share helpers Checking in Python? ├── Decide allow/deny → frappe.has_permission(...) or doc.has_permission(ptype) ├── Enforce abort → frappe.has_permission(..., throw=True) or doc.check_permission(ptype) ├── System/batch bypass → ignore_permissions (comments required) └── User-facing listings → frappe.get_list (NOT get_all) ``` ### Quick reference tables **Layers** | Layer | Purpose | |-------|---------| | Role permissions | Capability per DocType/action | | User permissions | Allowed Link values per user | | Perm levels | Hide/split sensitive fields | | Hooks | Extend/deny programmatically | | Data masking | Obfuscate sensitive fields | **permission_query_conditions vs get_list** | API | Applies user perms | Applies query hook | |-----|--------------------|---------------------| | `frappe.get_list()` | Yes | Yes | | `frappe.get_all()` | No | No | Typical **`ptype`** checks include `read`, `write`, `create`, `delete`, `submit`, `cancel`, `amend`; **`select`** exists for Link access (v14+). ### ALWAYS / NEVER (permissions) | ALWAYS | NEVER | |--------|--------| | Prefer **`frappe.has_permission(doctype, ptype, ...)`** for authorization — not raw role string checks alone. | Return **`True` from `has_permission` hooks** to “grant”; use **`None`** to defer to core rules. | | Use **`frappe.get_list`** for responses shown to authenticated users unless you deliberately bypass hooks. | Return user-controlled SQL fragments **without escaping** (`frappe.db.escape` for hook WHERE parts). | | Return **`False`/`None`** appropriately from **`has_permission`**; document **`ignore_permissions`**. | Raise **`frappe.throw` inside permission hooks** when denying — return **`False`** instead. | | Grant **`permlevel 0`** before granting higher permlevels. For hooks that build WHERE: prefix **`tab{Doctype}`** columns safely. | Assume **data masking** protects **raw SQL** or Query Reports — mask manually where needed **[v16+]** | ### Hook anti-pattern cheat sheet | Avoid | Prefer | |-------|--------| | `if "Role" in frappe.get_roles():` alone for gates | `frappe.has_permission(doctype, permtype)` | | `frappe.get_all()` for filtered user data | `frappe.get_list()` | | Concatenating unescaped `%`/`f-string` values into hook SQL snippets | `'owner = ' + frappe.db.escape(user)` | ### Precedence snapshot Administrator → Role permissions → User permissions → `has_permission` denials → Sharing/`if_owner` refinements — plan checks so cumulative rules stay predictable. --- Source attribution: vyogotech Original project: https://github.com/vyogotech/frappe-apps-manager/blob/75b80990a9cb5c0b15d31771349035d1d2095edb/.cursor/skills/frappe-secure-endpoint/SKILL.md License: MIT License information: https://opensource.org/license/mit Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice MIT License Copyright (c) 2025 Frappe Development Community Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # Mega AI Hub resource metadata Creator / publisher: vyogotech Original project: https://github.com/vyogotech/frappe-apps-manager/blob/75b80990a9cb5c0b15d31771349035d1d2095edb/.cursor/skills/frappe-secure-endpoint/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering, Product Management Roles: Backend Developer, Full-Stack Developer, Product Manager Specialties: API, Backend, Database, Word Documents, Frontend Tools: Frappe Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 58cf637148d0a6a29f31179e9ddfe6e9412cab549da0074ddb1b4d75078f60d7