multiRole

Register user with specific role (Local Auth)

Public endpoint for user registration with a specific role. The path segment must match a role's `signupEndpoint` (default starter is `customer`; add more roles via multi-role API). No authentication required - this is a public signup endpoint.

POST/api/auth/local/signup/{role}

Authentication

Public — No Auth Required

Path Parameters

NameTypeRequiredDescription
rolestringYesMust match the role's `signupEndpoint` (default `customer`; other values for roles you add).

Request Body

Registration payload (email, password, firstName, lastName, projectId).

json
{
  "email": "amari_koss69@northwind.dev",
  "password": "Str0ng_Sample_Pass!w0rd",
  "firstName": "Marjorie",
  "lastName": "Wyman",
  "projectId": "proj_qh5hFHNT70YZ"
}
{
  "email": "amari_koss69@northwind.dev",
  "password": "Str0ng_Sample_Pass!w0rd",
  "firstName": "Marjorie",
  "lastName": "Wyman",
  "projectId": "proj_qh5hFHNT70YZ"
}

SDK setup

Create a client instance. No authentication is required for this endpoint.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.auth.registerWithRole({
  role: "bandwidth program",
  email: "kathleen.gutmann1@northwind.dev",
  password: "Str0ng_Sample_Pass!w0rd",
  firstName: "Noble",
  lastName: "Frami",
  projectId: "proj_gxCFlUXkDgZb"
});
const result = await client.auth.registerWithRole({
  role: "bandwidth program",
  email: "kathleen.gutmann1@northwind.dev",
  password: "Str0ng_Sample_Pass!w0rd",
  firstName: "Noble",
  lastName: "Frami",
  projectId: "proj_gxCFlUXkDgZb"
});

Try It Live

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

No Request Yet

Send a request to see the full inspector

Responses

201Registration successful
400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.
404Role not found or not enabled

Errors

CodeMeaning
400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.
404Role not found or not enabled
Edit this page on GitHub