Skip to content
Dashboard
Theme
Theme

Change the active sign-in host

PUT /v1/environment/signin_host: Change the active sign-in host.

View Markdown

Passkey relying party.

PUT /v1/environment/signin_host

A deliberate change: confirm must equal the new host exactly (hostname, or signin.<domain> when hostname is null), typed by the user in the dashboard; otherwise parameter_invalid on confirm. hostname must be a verified (active) signin custom hostname of this environment (invariant 96; otherwise 404). New end-user passkeys bind to the new relying party; existing passkeys keep working only on the host whose relying party they were created under (invariant 95), and the response counts those that will not work on the new host (passkeys_not_usable). rp_id_scope hostname (default) binds passkeys to the hostname itself; registrable_domain binds them to its registrable domain (eTLD+1) so they also work on the customer’s other subdomains, which every subdomain of that domain can then also request. Deleting the custom hostname, or losing its verification, falls back to signin.<domain>. Audited (environment.signin_host_changed). A dashboard session needs a recent second factor (step_up_required).

Scope
custom_domains:write
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • hostname string or null Required

    A verified signin custom hostname of this environment, or null for signin.<domain>.

    max length 253

  • 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

  • confirm string Required

    The new host typed by the user; must equal hostname (or signin.<domain> when hostname is null).

    max length 253

Errors share one shape; see the error code catalogue.

curl -X PUT \
"https://api.ohauthcat.com/v1/environment/signin_host" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"hostname": "acme.com",
"confirm": "example_confirm"
}'
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"
}