Skip to content
Dashboard
Theme
Theme

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.

View Markdown

GET /v1/environment/signin_host

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
  • preview_hostname string

    max length 253

  • preview_rp_id_scope string

    How a custom sign-in host becomes the passkey relying party ID. hostname (default) uses the hostname itself; registrable_domain uses its registrable domain (eTLD+1).

    one of hostname, registrable_domain

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

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"
Response 200
{
"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"
}