Skip to content
Plune Plune Plune Docs

Add a domain to prove

POST
/v1/companies/{id}/sso/domains
 
curl --request POST \
  --url https://beta-api.plune.ai/v1/companies/example/sso/domains \
  --header 'Content-Type: application/json' \
  --cookie plune_session=<plune_session> \
  --data '{ "domain": "acme.example" }'

Owner only. Returns the DNS TXT record to create (_plune-sso.<domain>, value plune-sso-verification=<token>). A mail provider’s domain (gmail.com, outlook.com and the like) is refused: a company cannot prove it. A domain another company has already verified is 409. At most 20 a company. 20 a minute a person.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
domain
required
string
Example 
{
  "domain": "acme.example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

The domain, unverified, with its record

Media type application/json
object
domain
required
string
verified
required
boolean
verifiedAt
required
string format: date-time
nullable
record
required

The DNS TXT record that proves the domain: put value in a TXT record at name, then ask for the verification.

object
type
required
string
Allowed values: TXT
name
required
string
value
required
string
Example 
{
  "domain": "acme.example",
  "record": {
    "type": "TXT",
    "name": "_plune-sso.acme.example",
    "value": "plune-sso-verification=Zt3b…"
  }
}

400

Section titled “400 ”

Not a domain name, or a public mail domain (sso_public_mail_domain)

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

401

Section titled “401 ”

No / invalid session

403

Section titled “403 ”

The company does not have the saml option (code: tier_option_required, option: saml): a Team plan with the option, or Enterprise. Also: the caller is not the owner (or, for the read, a manager)

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

404

Section titled “404 ”

No such company, or the caller is not in it

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

409

Section titled “409 ”

sso_domain_taken or sso_limit

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

429

Section titled “429 ”

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the window rolls over