Herald
OpenapiExt

Create an organization

Creates a Herald organization for an app-side grouping, registering the external id and the owner account. Idempotent: replaying an existing `(clientApp, externalId)` returns the existing organization with `created = false` and does not update it. The first creation for a `(realm, client app)` seeds the three built-in tiers.

POST
/api/ext/realms/{realmId}/orgs

Creates a Herald organization for an app-side grouping, registering the external id and the owner account. Idempotent: replaying an existing (clientApp, externalId) returns the existing organization with created = false and does not update it. The first creation for a (realm, client app) seeds the three built-in tiers.

Authorization

api_key
X-API-Key<token>

Client-app API key (third-party external API).

In: header

Path Parameters

realmId*string

Realm ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

externalId*string

App-side identifier (workspace id etc.); unique per Client App, 1-255 chars after trim. Replaying an existing externalId returns the existing organization with created = false.

name?|

Optional display name (<= 255 chars).

ownerId*string

Owner account id; must belong to the same realm.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/ext/realms/string/orgs" \  -H "Content-Type: application/json" \  -d '{    "externalId": "string",    "ownerId": "string"  }'
{  "clientId": "string",  "created": true,  "createdAt": "string",  "externalId": "string",  "id": "string",  "name": "string",  "ownerId": "string",  "realmId": "string"}
{  "clientId": "string",  "created": true,  "createdAt": "string",  "externalId": "string",  "id": "string",  "name": "string",  "ownerId": "string",  "realmId": "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}