Skip to navigation

Verify

Check the claim. A verified single sign-on provider of this workspace for the same domain proves it already, with no record to publish; otherwise the TXT record has to be there. Verifying a verified domain changes nothing. Once verified, the domain is on the allow-list for go links and events while allowListed is on, and a partner domain of the same name is dropped, since that switch now decides. Errors: 409 not_proved (the record is not there yet: DNS can take a few minutes; the record to publish is in details.record), 409 verified_elsewhere.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

domainIdstringRequired

Response

This endpoint returns an object.
idstring
domainstring
verifiedboolean
autoJoinboolean

People who sign in with a confirmed address at the domain join as members, with a seat on each app that gives new members one. While it is on and the workspace’s autoGrowSeats is too (PATCH /organization), an app whose seats are all taken gets one more for them, and the seats paid for grow with it, prorated; otherwise they go on that app’s waiting list (GET /seats/waiting) and owners and admins are emailed.

restrictAccessboolean
allowListedboolean

On the workspace’s allow-list for go links and Dory events set to “People at certain email domains”, once verified: its people may prove an address and follow those links and join those events, without becoming members. On by default.

verificationobject
The DNS record that proves the workspace owns the domain.
createdAtdatetime
verifiedAtdatetimeOptional

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error