Platform · API Reference

Tenant Domain

Read and manage the tenant domain alias used by browser and API clients.

GET/api/v1/tenant/domain

List tenant domain

List tenant domain. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Query parameters

page	Zero-based page index where supported.
size	Page size where supported.

Responses

200Successful response.

400Invalid request.

401Missing or invalid authentication.

403Forbidden by permission, SKU, or provider-admin policy.

404Resource not found or not in the caller's tenant.

Example request

cURL

curl -X GET "https://api.authspoke.com/api/v1/tenant/domain" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

{
  "id": "uuid",
  "status": "OK"
}

PUT/api/v1/tenant/domain/alias

Replace domain alias

Replace domain alias. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Request body

name	string	Display name or operation name where applicable.
status	string	Status or lifecycle value where applicable.
reason	string	Audit reason for governed changes.
metadata	object	Provider or business metadata.
configuration	object	Connector, policy, or resource configuration.

Responses

200Successful response.

400Invalid request.

401Missing or invalid authentication.

403Forbidden by permission, SKU, or provider-admin policy.

404Resource not found or not in the caller's tenant.

Example request

cURL

curl -X PUT "https://api.authspoke.com/api/v1/tenant/domain/alias" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

{
  "id": "uuid",
  "status": "OK"
}

DELETE/api/v1/tenant/domain/alias

Delete domain alias

Delete domain alias. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Responses

204Deleted or completed with no response body.

400Invalid request.

401Missing or invalid authentication.

403Forbidden by permission, SKU, or provider-admin policy.

404Resource not found or not in the caller's tenant.

Example request

cURL

curl -X DELETE "https://api.authspoke.com/api/v1/tenant/domain/alias" \
  -H "Authorization: Bearer $TOKEN"