sso.addDomain

POST

/v1/organization/domains

const url = 'https://example.com/v1/organization/domains';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"domain":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/organization/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "domain": "example" }'

Adds an email domain. Then add the TXT record that the answer names, and call the verify endpoint.

Authorizations

token
session

Request Body^required

application/json

object

domain

required

string

Example ^generated

{
  "domain": "example"
}

Responses

200

Success

application/json

object

domain

required

string

recordName

required

string

recordValue

required

string

verifiedAt

required

Any of:

string
null

string

createdAt

required

string

Example ^generated

{
  "domain": "example",
  "recordName": "example",
  "recordValue": "example",
  "verifiedAt": "example",
  "createdAt": "example"
}

400

SsoConnectionInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: SsoConnectionInvalid

message

required

string

Example

{
  "_tag": "SsoConnectionInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

DomainNotFound | SsoConnectionNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: DomainNotFound

domain

required

string

Example

{
  "_tag": "DomainNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict

application/json

Any of:

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

SsoUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}

sso.addDomain

Authorizations

Request Bodyrequired

Example generated

Responses

200

Example generated

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

503

Example

Request Body^required

Example ^generated

Example ^generated