multiRole

Get multi-role feature configuration

Returns project app roles (default one editable `customer` starter until you add more) and settings.

GET/api/projects/{projectId}/multi-role

Authentication

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.

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.getConfig({
  projectId: "proj_IvFElGUYt1vw"
});
const result = await client.multiRole.getConfig({
  projectId: "proj_IvFElGUYt1vw"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

JWT Bearer Token Use the auth endpoints to obtain a JWT.

Path Parameters

projectId

No Request Yet

Send a request to see the full inspector

Responses

200Multi-role configuration

json

{
  "success": true,
  "data": {
    "isEnabled": true,
    "defaultRole": "customer",
    "settings": {
      "allowMultipleRoles": false,
      "requireRoleSelection": false,
      "autoAssignDefault": true
    },
    "roles": [
      {
        "slug": "customer",
        "name": "Customer",
        "description": "Default app user role. Edit name/slug and assign create/read/update/delete per collection after you add schemas.",
        "isEnabled": true,
        "isCustom": true,
        "signupEndpoint": "customer",
        "requiresApproval": false,
        "requiresPayment": false,
        "requiresKYC": false,
        "defaultPermissions": [],
        "collectionPermissions": []
      }
    ]
  }
}
{
  "success": true,
  "data": {
    "isEnabled": true,
    "defaultRole": "customer",
    "settings": {
      "allowMultipleRoles": false,
      "requireRoleSelection": false,
      "autoAssignDefault": true
    },
    "roles": [
      {
        "slug": "customer",
        "name": "Customer",
        "description": "Default app user role. Edit name/slug and assign create/read/update/delete per collection after you add schemas.",
        "isEnabled": true,
        "isCustom": true,
        "signupEndpoint": "customer",
        "requiresApproval": false,
        "requiresPayment": false,
        "requiresKYC": false,
        "defaultPermissions": [],
        "collectionPermissions": []
      }
    ]
  }
}

401Authentication required or invalid token.

403Access denied or insufficient permissions.

Errors

Code	Meaning
`401`	Authentication required or invalid token.
`403`	Access denied or insufficient permissions.

Run in Postman Download OpenAPI

Next steps

Edit this page on GitHub