Skip to main content
POST
Add Organization Domain

Authorizations

Authorization
string
header
required

A Barndoor API key, sent as Authorization: Bearer <key>. Keys are prefixed bdai_ and are opaque — do not attempt to decode one. Interchangeable with an OAuth 2.0 access token.

Scopes

openid

Issue an OIDC ID token identifying the caller.

profile

Read the caller's basic profile claims.

email

Read the caller's email address.

Body

application/json

Request to claim a domain, or start verifying an existing Keycloak one.

domain
string
required
Minimum string length: 1

Response

Successful Response

One domain: either a claim (pending/verified/failed) or an existing Keycloak domain with no claim row (unverified).

record_name/record_value are the TXT record to publish — present for every claim status so the UI can show/copy it even after a failed attempt.

domain
string
required
status
string
required
claim_id
string<uuid> | null
verification_method
string | null
record_name
string | null
record_value
string | null
verified_at
string<date-time> | null
last_checked_at
string<date-time> | null
last_error
string | null