multiRole

Toggle role on/off

Enable or disable a role for the project. When disabled, the role is no longer available for signup or assignment.

PATCH/api/projects/{projectId}/multi-role/roles/{roleSlug}/toggle

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

NameTypeRequiredDescription
projectIdstringYesProject ID.
roleSlugstringYesRole slug to toggle (e.g. starter `customer` or a role you added).

Request Body

Whether the role is enabled (true) or disabled (false).

json
{
  "isEnabled": true
}
{
  "isEnabled": 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.toggleRole({
  projectId: "proj_9a7QHQOT1bTN",
  roleSlug: "each-sediment-m48f",
  isEnabled: false
});
const result = await client.multiRole.toggleRole({
  projectId: "proj_9a7QHQOT1bTN",
  roleSlug: "each-sediment-m48f",
  isEnabled: false
});

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

200Role toggled
json
{
  "success": true,
  "message": "Role enabled",
  "data": {
    "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,
  "message": "Role enabled",
  "data": {
    "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": []
  }
}
400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Errors

CodeMeaning
400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Next steps

Edit this page on GitHub