Set the primary platform tenant vanity domain.

POST

/api/admin/platform/tenant-vanity-domains/{id}/primary

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/platform/tenant-vanity-domains/example/primary \
  --header 'Authorization: Bearer <token>'

Make an active vanity domain the canonical primary hostname for its tenant. The operation fails if the domain is not active.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Tenant vanity domain identifier.

Responses

200

Tenant vanity domain record.

Media type application/json

object

id

required

string

tenant_id

required

string

hostname

required

string

is_active

required

boolean

is_primary

required

boolean

status

required

string

Allowed values: pending pending_manual active failed deleted

cloudflare_zone_id

required

string | null

cloudflare_custom_hostname_id

required

string | null

ssl_status

required

string | null

ownership_status

required

string | null

validation_method

required

string | null

validation_records

required

object | null

last_sync_at

required

integer | null format: int64

created_by

required

string | null

created_at

required

integer format: int64

updated_at

required

integer format: int64

key

additional properties

Example

{
  "id": "dom_123",
  "tenant_id": "tenant_123",
  "hostname": "login.example.com",
  "is_active": true,
  "is_primary": true,
  "status": "active",
  "cloudflare_zone_id": "zone_123",
  "cloudflare_custom_hostname_id": "cfh_123",
  "ssl_status": "active",
  "ownership_status": "active",
  "validation_method": "http",
  "validation_records": {
    "ownership_verification_http": {
      "http_url": "http://login.example.com/.well-known/cf-custom-hostname-challenge/abc",
      "http_body": "challenge-token"
    },
    "ssl_validation_records": null
  },
  "last_sync_at": 1770000000,
  "created_by": "admin_123",
  "created_at": 1769996400,
  "updated_at": 1770000000
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}