Herald
OpenapiAuth

Provision a new realm from an unauthenticated visitor and issue an immediate first-party admin-console session for the new realm admin.

Only the admin realm hosts this entry; any other `realmId` is rejected. Pre-flight defenses run before any realm is created: the platform toggle, human verification bound to the admin realm's `admin-web-console` Client App, and a same-IP 24h quota.

POST
/api/auth/{realmId}/signup

Only the admin realm hosts this entry; any other realmId is rejected. Pre-flight defenses run before any realm is created: the platform toggle, human verification bound to the admin realm's admin-web-console Client App, and a same-IP 24h quota.

Path Parameters

realmId*string

Must be "admin"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string
password*string
realmName*string
realmSlug?string|null
turnstileToken?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/auth/string/signup" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "password": "string",    "realmName": "string"  }'
{  "accessToken": "string",  "expiresIn": 0,  "realmId": "string",  "realmName": "string",  "refreshExpiresIn": 0,  "refreshToken": "string",  "tokenType": "string"}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}