Herald
OpenapiExt

List realms

Returns the realms visible to the caller. Principals in the `admin` realm see all realms (platform-level enumeration); every other principal sees only its own realm. Realm-level detail endpoints remain strictly own-realm — this list is the only platform-wide view. # Authentication Requires valid API Key via X-API-Key header # Authorization The caller must have `realm:view` permission in their own realm.

GET
/api/ext/realms

Returns the realms visible to the caller. Principals in the admin realm see all realms (platform-level enumeration); every other principal sees only its own realm. Realm-level detail endpoints remain strictly own-realm — this list is the only platform-wide view.

Authentication

Requires valid API Key via X-API-Key header

Authorization

The caller must have realm:view permission in their own realm.

Authorization

api_key
X-API-Key<token>

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

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/ext/realms"
{  "realms": [    {      "createdAt": "string",      "description": "string",      "id": "string",      "name": "string",      "updatedAt": "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}