Skip to content
Dashboard
Theme
Theme

Update the environment

PATCH /v1/environment: Update the environment.

View Markdown

PATCH /v1/environment

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

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

  • consent_screen_default string

    one of on, off

  • sign_in_failed_events boolean

    Opt in to sso.sign_in.failed for refused sign-ins.

  • compat_workos_enabled boolean

    Enable or disable WorkOS SSO compatibility for this environment. It remains unavailable when the deployment kill switch is off; native caller PKCE is unchanged.

  • version_pin string

  • portal_success_urls object

  • disabled_notices array of string

    Customer-facing notices not mailed to the organizations’ IT contacts (the environment’s owners and admins still get them). Empty by default.

    max items 4

  • portal_logo_url string (uri) or null

    Where the setup portal’s logo links (https). “” clears it.

    max length 2048

  • portal_embed_origins array of string

    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 (SameSite=None; Secure; Partitioned) so they work inside the iframe, and the portal’s edge sends a Content-Security-Policy frame-ancestors directive with these origins. An empty list turns embedding off.

    max items 20

  • support_email string or null

    Customer support address shown in the setup portal and used as the reply-to of IT-contact mail. “” clears it.

    max length 320

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