Get the active sign-in host and passkey relying party
GET /v1/environment/signin_host: Get the active sign-in host and passkey relying party.
GET /
The environment’s active hosted sign-in host (hostname null means signin.<domain>) and the WebAuthn relying party ID (rp_id) new end-user passkeys bind to. With preview_hostname (a verified signin custom hostname of this environment, or signin.<domain>) and optionally preview_rp_id_scope, passkeys_not_usable counts the environment’s end-user passkeys that would not work after switching to it; without it, the count is for the current host (passkeys created under another relying party). A preview hostname that is not a verified signin hostname of this environment answers 404.
- Scope
custom_domains:read- Auth
- Secret key (
sk_…) - Since
- 1.0
Query parameters
Section titled “Query parameters”preview_hostnamestringmax length 253
How a custom sign-in host becomes the passkey relying party ID.preview_rp_id_scopestringhostname(default) uses the hostname itself;registrable_domainuses its registrable domain (eTLD+1).one of
hostname,registrable_domain
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 OK EnvironmentSigninHost
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X GET \ "https://api.ohauthcat.com/v1/environment/signin_host" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY"const response = await fetch("https://api.ohauthcat.com/v1/environment/signin_host", { method: "GET", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://api.ohauthcat.com/v1/environment/signin_host", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "object": "environment_signin_host", "hostname": "acme.com", "default_hostname": "example_default_hostname", "rp_id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "rp_id_scope": "hostname", "passkeys_not_usable": 0, "updated_at": "2026-01-15T09:30:00Z"}