iam.sso-connections.add-domain

Claim an email domain; returns the TXT record that proves it

POST /iam/api/sso-connections/{id}/domainsIAM iam:UpdateSsoConnectionChanges stateDestructive

Request syntax

POST /iam/api/sso-connections/{id}/domains
{
  "domain": "string"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • domainRequired

    string

    An email domain the organization owns, e.g. acme.com

    Constraints: 3-253 chars

Response

201 with { id, domain, record }: record is the DNS entry to publish, { type: "TXT", name, value }; then call verify-domain.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow iam:UpdateSsoConnection on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud iam sso-connections add-domain id --domain example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_iam_sso-connections_add-domain.