Skip to content
Authrim

List tenant vanity domains.

GET
/api/admin/tenant-vanity-domains
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/tenant-vanity-domains \
  --header 'Authorization: Bearer <token>'

List vanity domains for the current tenant, ordered with the primary domain first.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Tenant vanity domain list response.

Media type application/json
object
domains
required
Array<object>
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
cloudflare_configured
required
boolean
key
additional properties
Example 
{
  "domains": [
    {
      "id": "domain_123",
      "tenant_id": "default",
      "hostname": "login.example.com",
      "is_active": true,
      "is_primary": false,
      "status": "pending_manual",
      "cloudflare_zone_id": null,
      "cloudflare_custom_hostname_id": null,
      "ssl_status": null,
      "ownership_status": null,
      "validation_method": "http",
      "validation_records": {
        "ownership_verification": null,
        "ownership_verification_http": null,
        "ssl_validation_records": null
      },
      "last_sync_at": null,
      "created_by": "admin_123",
      "created_at": 1770000000,
      "updated_at": 1770000000
    }
  ]
}