multiRole

Get available roles for signup

Get all available roles for user signup in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

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

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.

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

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

200List of available roles
json
{
  "success": true,
  "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.",
      "signupEndpoint": "customer",
      "requiresApproval": false,
      "requiresPayment": false,
      "requiresKYC": false
    }
  ]
}
{
  "success": true,
  "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.",
      "signupEndpoint": "customer",
      "requiresApproval": false,
      "requiresPayment": false,
      "requiresKYC": false
    }
  ]
}
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Errors

CodeMeaning
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Next steps

Edit this page on GitHub