Skip to content
Authrim

Update a tenant vanity domain.

PATCH
/api/admin/tenant-vanity-domains/{id}
Code sample: Shell / cURL 
curl --request PATCH \
  --url https://auth.example.com/api/admin/tenant-vanity-domains/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "is_active": false }'

Activate or deactivate a tenant vanity domain. Deactivating also clears primary-domain status for the record.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Header Parameters

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

Tenant selector for multi-tenant admin requests.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
>= 1 properties
is_active
boolean
key
additional properties
Example 
{
  "is_active": false
}

Responses

Section titled “ Responses ”

200

Section titled “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

Section titled “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"
}

404

Section titled “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"
}