Skip to content
Kapten
Esc
↑↓navigate↵open⌘Jpreview

Verify an email domain of the identity provider

Requires organization:update. Kapten looks up the domain’s TXT record: 400 when it does not hold the expected value, 409 when another organization verified the domain first, 404 for a domain the connection does not have. Verifying a verified domain changes nothing.

POST/organizations/{organizationId}/sso/domains/{domain}/verify
Authorization
AuthorizationBearer token (JWT) · headerrequired

An access token issued by this service (RFC 9068), in the Authorization header as Bearer <token>.

Path parameters
organizationIdstring<uuid>required
domainstringrequired
Responses
200

The connection, with the domain verified.

issuerstringrequired

The provider's issuer identifier; auth reads {issuer}/.well-known/openid-configuration.

client_idstringrequired
redirect_uristringrequired

The redirect URI to register at the provider, the same for every organization.

domainssso_domain[]required

The organization's email domains, sorted. Once verified, a domain is routed to the provider (home realm discovery), and only verified addresses on verified domains may sign in through it.

Show properties
Array of sso_domain
domainstringrequired
record_namestringrequired

Name of the TXT record to publish, _kapten-sso.<domain>.

record_valuestringrequired

Value of the TXT record.

verified_atstring<date-time>

When the record was found; absent while the domain is unverified and not routed.

enforcedbooleanrequired

Members must sign in through the provider to get tokens for the organization; owners are exempt so a broken provider never locks the organization out.

provisioning_rolestring

Role given to people on their first SSO login (just-in-time provisioning); absent when it is off and only invited people or members can sign in.

created_atstring<date-time>required
updated_atstring<date-time>required
default

The request failed.

errorstringrequired

Stable machine-readable code.

Allowed:invalid_requestunauthorizedforbiddennot_foundconflictgoneunavailableinternal
messagestringrequired

Human-readable explanation.

Request
curl -X POST 'https://auth.kapten.io/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/domains/string/verify' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "issuer": "string",
  "client_id": "string",
  "redirect_uri": "string",
  "domains": [
    {
      "domain": "string",
      "record_name": "string",
      "record_value": "string",
      "verified_at": "2019-08-24T14:15:22Z"
    }
  ],
  "enforced": true,
  "provisioning_role": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}