Claim Organisation Domain
Claim a domain for the organisation, pending DNS verification.
Authorization: caller must be an admin or owner.
A domain can only be claimed by one organisation at a time (globally
unique, not just within this org). The claim is unverified until
verify_domain confirms the DNS TXT record; a verified domain is a
prerequisite for enabling SSO on the organisation.
Authorization
OAuth2AuthorizationCodeBearer AuthorizationBearer <token>
In: header
Path Parameters
org_id*Org Id
Format
uuidQuery Parameters
verify_locally?Verify Locally
Default
trueRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/organisations/497f6eca-6276-4993-bfeb-53cbbbba6f08/domains" \ -H "Content-Type: application/json" \ -d '{ "domain": "string" }'{ "domain": "string", "verification_token": "string", "dns_record_name": "string", "dns_record_value": "string"}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}