Change the active sign-in host
PUT /v1/environment/signin_host: Change the active sign-in host.
Passkey relying party.
PUT /
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.). A dashboard session needs a recent second factor (step_up_required).
- Scope
custom_domains:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”
A verified signin custom hostname of this environment, or null forhostnamestring or null Requiredsignin.<domain>.max length 253
How a custom sign-in host becomes the passkey relying party ID.rp_id_scopestringhostname(default) uses the hostname itself;registrable_domainuses its registrable domain (eTLD+1).one of
hostname,registrable_domain
The new host typed by the user; must equalconfirmstring Requiredhostname(orsignin.<domain>whenhostnameis null).max length 253
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 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"}'const response = await fetch("https://api.ohauthcat.com/v1/environment/signin_host", { method: "PUT", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "hostname": "acme.com", "confirm": "example_confirm" }),});const data = await response.json();import osimport requests
response = requests.put( "https://api.ohauthcat.com/v1/environment/signin_host", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "hostname": "acme.com", "confirm": "example_confirm", },)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"}