PATCH /v1/environment
- Scope
environment:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”consent_screen_defaultstringone of
on,off
Opt in tosign_in_failed_eventsbooleansso.sign_in.failedfor refused sign-ins.
Enable or disable WorkOS SSO compatibility for this environment. It remains unavailable when the deployment kill switch is off; native caller PKCE is unchanged.compat_workos_enabledbooleanversion_pinstringportal_success_urlsobject
Customer-facing notices not mailed to the organizations’ IT contacts (the environment’s owners and admins still get them). Empty by default.disabled_noticesarray of stringmax items 4
Where the setup portal’s logo links (https). “” clears it.portal_logo_urlstring (uri) or nullmax length 2048
The https origins (scheme and host, optional port; no path) allowed to show the setup portal in an iframe. Empty (the default) keeps embedding off. While it is set, new portal sessions use a partitioned third-party cookie (portal_embed_originsarray of stringSameSite=None; Secure; Partitioned) so they work inside the iframe, and the portal’s edge sends aContent-Security-Policyframe-ancestorsdirective with these origins. An empty list turns embedding off.max items 20
Customer support address shown in the setup portal and used as the reply-to of IT-contact mail. “” clears it.support_emailstring or nullmax length 320
Responses
Section titled “Responses”- 200 OK Environment
- 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
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. 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 PATCH \ "https://api.ohauthcat.com/v1/environment" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "consent_screen_default": "on", "sign_in_failed_events": true, "compat_workos_enabled": true, "version_pin": "example_version_pin", "portal_success_urls": {}, "disabled_notices": [ "cert_expiry" ], "portal_logo_url": "https://app.acme.com/callback", "portal_embed_origins": [ "example_portal_embed_origin" ], "support_email": "jane@acme.com"}'const response = await fetch("https://api.ohauthcat.com/v1/environment", { method: "PATCH", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "consent_screen_default": "on", "sign_in_failed_events": true, "compat_workos_enabled": true, "version_pin": "example_version_pin", "portal_success_urls": {}, "disabled_notices": [ "cert_expiry" ], "portal_logo_url": "https://app.acme.com/callback", "portal_embed_origins": [ "example_portal_embed_origin" ], "support_email": "jane@acme.com" }),});const data = await response.json();import osimport requests
response = requests.patch( "https://api.ohauthcat.com/v1/environment", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "consent_screen_default": "on", "sign_in_failed_events": True, "compat_workos_enabled": True, "version_pin": "example_version_pin", "portal_success_urls": {}, "disabled_notices": [ "cert_expiry", ], "portal_logo_url": "https://app.acme.com/callback", "portal_embed_origins": [ "example_portal_embed_origin", ], "support_email": "jane@acme.com", },)data = response.json(){ "id": "env_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "environment", "project": "proj_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "type": "sandbox", "consent_screen_default": "on", "sign_in_failed_events": true, "gusto_oauth_available": true, "bamboohr_oauth_available": true, "google_oauth_available": true, "compat_workos_enabled": false, "version_pin": "example_version_pin", "home_region": "example_home_region", "portal_success_urls": {}, "disabled_notices": [ "cert_expiry" ], "portal_logo_url": "https://app.acme.com/callback", "portal_embed_origins": [ "example_portal_embed_origin" ], "support_email": "jane@acme.com", "sign_ins_disabled": true, "sign_ins_disabled_at": "2026-01-15T09:30:00Z", "sign_ins_disabled_by": "customer", "residency": { "region": "eu", "data_classes": [ { "data_class": "example_data_class", "description": "Primary SSO connection for Acme Corp.", "scope": "home_region", "region": "eu", "personal_data": true } ] }}