multiRole
Add custom role
Add a custom role to a project with specific permissions and signup endpoint. Optional **featurePermissions** must align with app JWT gates — see schema `AppRoleFeaturePermissions`. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).
POST
/api/projects/{projectId}/multi-role/rolesAuthentication
Requires JWT
Note
Include your JWT in the
Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | Project ID. |
Request Body
Custom role definition. Use `collectionPermissions` to apply CRUD per collection slug (e.g. users/products/orders). `defaultPermissions` is optional for global/base permissions.
json
{
"slug": "seller",
"name": "Seller",
"description": "Seller role with CRUD on seller-owned collections",
"signupEndpoint": "seller",
"requiresApproval": false,
"requiresPayment": false,
"requiresKYC": false,
"defaultPermissions": [
{
"resource": "panel calculate",
"actions": [
"alarm transmit"
]
}
],
"collectionPermissions": {},
"metadata": {},
"featurePermissions": {
"messaging": {
"email": true,
"sms": true,
"push": false
},
"integration": {
"read": true,
"execute": true
}
}
}{
"slug": "seller",
"name": "Seller",
"description": "Seller role with CRUD on seller-owned collections",
"signupEndpoint": "seller",
"requiresApproval": false,
"requiresPayment": false,
"requiresKYC": false,
"defaultPermissions": [
{
"resource": "panel calculate",
"actions": [
"alarm transmit"
]
}
],
"collectionPermissions": {},
"metadata": {},
"featurePermissions": {
"messaging": {
"email": true,
"sms": true,
"push": false
},
"integration": {
"read": true,
"execute": true
}
}
}SDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { MudbaseClient } from "mudbase";
const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");import { MudbaseClient } from "mudbase";
const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const result = await client.multiRole.addRole({
projectId: "proj_JqyHvfqPn2rL",
slug: "secret-legislature-fcta",
name: "Loma Kuhic",
signupEndpoint: "panel bypass",
description: "Introducing the Nepal-inspired Table, blending natural style with local craftsmanship",
requiresApproval: true,
requiresPayment: false,
requiresKYC: false,
defaultPermissions: "feed compress",
collectionPermissions: "protocol parse",
metadata: "bandwidth input",
featurePermissions: "protocol hack"
});const result = await client.multiRole.addRole({
projectId: "proj_JqyHvfqPn2rL",
slug: "secret-legislature-fcta",
name: "Loma Kuhic",
signupEndpoint: "panel bypass",
description: "Introducing the Nepal-inspired Table, blending natural style with local craftsmanship",
requiresApproval: true,
requiresPayment: false,
requiresKYC: false,
defaultPermissions: "feed compress",
collectionPermissions: "protocol parse",
metadata: "bandwidth input",
featurePermissions: "protocol hack"
});Try It Live
Test this endpoint with your own credentials. Your requests will be sent to the live API.
Use the auth endpoints to obtain a JWT.
No Request Yet
Send a request to see the full inspector
Responses
201Custom role added
json
{
"success": true,
"message": "Custom role added",
"data": {
"slug": "seller",
"name": "Seller",
"description": "Seller role with CRUD on seller-owned collections",
"isEnabled": true,
"isCustom": true,
"signupEndpoint": "seller",
"requiresApproval": false,
"requiresPayment": false,
"requiresKYC": false,
"defaultPermissions": [
{
"resource": "project",
"actions": [
"read"
]
},
{
"resource": "data",
"actions": [
"read",
"create"
]
}
],
"collectionPermissions": [
{
"collectionSlug": "listings",
"actions": [
"create",
"read",
"update",
"delete"
]
},
{
"collectionSlug": "orders",
"actions": [
"create",
"read"
],
"conditions": {
"status": "active"
}
}
],
"metadata": {},
"featurePermissions": {
"messaging": {
"email": true,
"sms": true,
"push": true,
"history": true,
"stats": true
},
"integration": {
"read": true,
"create": true,
"update": true,
"delete": false,
"execute": true,
"test": true,
"export": true,
"read_usage": true
},
"functions": {
"create": true,
"read": true,
"update": true,
"delete": false,
"execute": true,
"simulate": true
},
"data": {
"create": true,
"read": true,
"update": true,
"delete": false
},
"search": {
"query": true,
"suggestions": true,
"read_analytics": true
},
"usage": {
"read": true
},
"storage": {
"read": true,
"create": true,
"update": true,
"delete": false,
"upload": true
},
"chat": {
"read": true,
"create": true,
"update": true,
"delete": false
},
"realtime": {
"read_analytics": true,
"read_active_users": true,
"presence": true,
"read_throughput": true,
"read_history": true
},
"roleElevation": {
"request": true,
"status": true,
"documents": true
},
"webhooks": {
"config_read": true,
"config_update": true,
"test_transformation": true
}
}
}
}{
"success": true,
"message": "Custom role added",
"data": {
"slug": "seller",
"name": "Seller",
"description": "Seller role with CRUD on seller-owned collections",
"isEnabled": true,
"isCustom": true,
"signupEndpoint": "seller",
"requiresApproval": false,
"requiresPayment": false,
"requiresKYC": false,
"defaultPermissions": [
{
"resource": "project",
"actions": [
"read"
]
},
{
"resource": "data",
"actions": [
"read",
"create"
]
}
],
"collectionPermissions": [
{
"collectionSlug": "listings",
"actions": [
"create",
"read",
"update",
"delete"
]
},
{
"collectionSlug": "orders",
"actions": [
"create",
"read"
],
"conditions": {
"status": "active"
}
}
],
"metadata": {},
"featurePermissions": {
"messaging": {
"email": true,
"sms": true,
"push": true,
"history": true,
"stats": true
},
"integration": {
"read": true,
"create": true,
"update": true,
"delete": false,
"execute": true,
"test": true,
"export": true,
"read_usage": true
},
"functions": {
"create": true,
"read": true,
"update": true,
"delete": false,
"execute": true,
"simulate": true
},
"data": {
"create": true,
"read": true,
"update": true,
"delete": false
},
"search": {
"query": true,
"suggestions": true,
"read_analytics": true
},
"usage": {
"read": true
},
"storage": {
"read": true,
"create": true,
"update": true,
"delete": false,
"upload": true
},
"chat": {
"read": true,
"create": true,
"update": true,
"delete": false
},
"realtime": {
"read_analytics": true,
"read_active_users": true,
"presence": true,
"read_throughput": true,
"read_history": true
},
"roleElevation": {
"request": true,
"status": true,
"documents": true
},
"webhooks": {
"config_read": true,
"config_update": true,
"test_transformation": true
}
}
}
}400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.
Errors
| Code | Meaning |
|---|---|
400 | Bad request or validation error. |
401 | Authentication required or invalid token. |
403 | Access denied or insufficient permissions. |