--- title: Update your Zero Trust organization --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Zero Trust](https://developers.cloudflare.com/api/resources/zero_trust) [Organizations](https://developers.cloudflare.com/api/resources/zero_trust/subresources/organizations) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Update your Zero Trust organization PUT/{accounts\_or\_zones}/{account\_or\_zone\_id}/access/organizations Updates the configuration for your Zero Trust organization. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `Access: Organizations, Identity Providers, and Groups Write` ##### P ath ParametersExpand Collapse account\_id: optional string The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) zone\_id: optional string The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) ##### Body ParametersJSONExpand Collapse allow\_authenticate\_via\_warp: optional boolean When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20allow_authenticate_via_warp%20%3E%20(schema)>) auth\_domain: optional string The unique subdomain assigned to your Zero Trust organization. If omitted on creation, a unique subdomain is auto-generated in the format `adjective-noun-hex4` (e.g. `frosty-moon-7a3b.cloudflareaccess.com`). [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20auth_domain%20%3E%20(schema)>) auto\_redirect\_to\_identity: optional boolean When set to `true`, users skip the identity provider selection step during login. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20auto_redirect_to_identity%20%3E%20(schema)>)

custom\_pages: optional object {forbidden, identity\_denied }

forbidden: optional string The uid of the custom page to use when a user is denied access after failing a non-identity rule. Link to this property identity\_denied: optional string The uid of the custom page to use when a user is denied access. Link to this property

[Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20custom_pages%20%3E%20(schema)>) deny\_unmatched\_requests: optional boolean Determines whether to deny all requests to Cloudflare-protected resources that lack an associated Access application. If enabled, you must explicitly configure an Access application and policy to allow traffic to your Cloudflare-protected resources. For domains you want to be public across all subdomains, add the domain to the `deny_unmatched_requests_exempted_zone_names` array. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20deny_unmatched_requests%20%3E%20(schema)>) deny\_unmatched\_requests\_exempted\_zone\_names: optional array of string Contains zone names to exempt from the `deny_unmatched_requests` feature. Requests to a subdomain in an exempted zone will block unauthenticated traffic by default if there is a configured Access application and policy that matches the request. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20deny_unmatched_requests_exempted_zone_names%20%3E%20(schema)>) is\_ui\_read\_only: optional boolean Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20is_ui_read_only%20%3E%20(schema)>)

background\_color: optional string The background color on your login page. Link to this property footer\_text: optional string The text at the bottom of your login page. Link to this property header\_text: optional string The text at the top of your login page. Link to this property logo\_path: optional string The URL of the logo on your login page. Link to this property text\_color: optional string The text color on your login page. Link to this property

[Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20login_design%20%3E%20(schema)>)

mfa\_config: optional object {allowed\_authenticators, amr\_matching\_session\_duration, required\_aaguids, session\_duration } Configures multi-factor authentication (MFA) settings for an organization.

allowed\_authenticators: optional array of "totp"or "biometrics"or "security\_key"or 2 more Lists the MFA methods that users can authenticate with. The piv_key and ssh_fido2_key values are supported only for infrastructure applications.

One of the following: "totp" Link to this property "biometrics" Link to this property "security\_key" Link to this property "piv\_key" Link to this property "ssh\_fido2\_key" Link to this property

Link to this property amr\_matching\_session\_duration: optional string Allows a user to skip MFA via Authentication Method Reference (AMR) matching when the AMR claim provided by the IdP the user used to authenticate contains “mfa”. Must be in minutes (m) or hours (h). Minimum: 0m. Maximum: 720h (30 days). Link to this property required\_aaguids: optional string Specifies a Cloudflare List of required FIDO2 authenticator device AAGUIDs. formatuuid Link to this property session\_duration: optional string Defines the duration of an MFA session. Must be in minutes (m) or hours (h). Minimum: 0m. Maximum: 720h (30 days). Examples:5m or 24h. Link to this property

[Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20mfa_config%20%3E%20(schema)>)

mfa\_piv\_key\_requirements: optional object {pin\_policy, require\_fips\_device, ssh\_key\_size, 2 more } Configures PIV key requirements for MFA using hardware security keys.

pin\_policy: optional "never"or "once"or "always" Defines when a PIN is required to use the SSH key. Valid values: never (no PIN required), once (PIN required once per session), always (PIN required for each use).

One of the following: "never" Link to this property "once" Link to this property "always" Link to this property

Link to this property require\_fips\_device: optional boolean Requires the PIV key to be stored on a FIPS 140-2 Level 1 or higher validated device. Link to this property

ssh\_key\_size: optional array of 256or 384or 521or 3 more Specifies the allowed SSH key sizes in bits. Valid sizes depend on key type. Ed25519 has a fixed key size and does not accept this parameter.

One of the following: 256 Link to this property 384 Link to this property 521 Link to this property 2048 Link to this property 3072 Link to this property 4096 Link to this property

Link to this property

ssh\_key\_type: optional array of "ecdsa"or "ed25519"or "rsa" Specifies the allowed SSH key types. Valid values are ecdsa, ed25519, and rsa.

One of the following: "ecdsa" Link to this property "ed25519" Link to this property "rsa" Link to this property

Link to this property

touch\_policy: optional "never"or "always"or "cached" Defines when physical touch is required to use the SSH key. Valid values: never (no touch required), always (touch required for each use), cached (touch cached for 15 seconds).

One of the following: "never" Link to this property "always" Link to this property "cached" Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20mfa_piv_key_requirements%20%3E%20(schema)>) mfa\_required\_for\_all\_apps: optional boolean Determines whether global MFA settings apply to applications by default. The organization must have MFA enabled with at least one authentication method and a session duration configured. Note: ‘allowed\_authenticators’ cannot contain only the infrastructure SSH authenticators (‘piv\_key’ and ‘ssh\_fido2\_key’) if the organization has any non-infrastructure applications. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20mfa_required_for_all_apps%20%3E%20(schema)>) name: optional string The name of your Zero Trust organization. When omitted on creation, defaults to the provided auth\_domain; when both are omitted, defaults to the auto-generated subdomain slug (e.g. frosty-moon-7a3b). [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20name%20%3E%20(schema)>)

service\_token\_inactivity: optional object {action, enabled, inactivity\_threshold\_days } Configures automatic enforcement for inactive service tokens. A service token is inactive if no policy references it, and it has not successfully authenticated with an Access application during the selected inactivity period. This setting applies to every service token in your Zero Trust account.

action: "disable"or "delete" The action applied to an inactive service token.

One of the following: "disable" Link to this property "delete" Link to this property

Link to this property enabled: boolean Whether automatic enforcement for inactive service tokens is enabled. Link to this property inactivity\_threshold\_days: number The number of days a service token must be inactive before the configured action is applied. maximum365 minimum30 Link to this property

[Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20service_token_inactivity%20%3E%20(schema)>) session\_duration: optional string The amount of time that tokens issued for applications will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20session_duration%20%3E%20(schema)>) strict\_service\_token\_auth: optional boolean Enables new behaviors for requests made with Access service tokens. Unauthorized requests emit audit logs, and return a 401 or 403 status code in the response instead of redirecting to the login page. Successful requests no longer receive a CF\_Authorization cookie in the response. Zero Trust organizations created on or after October 5, 2026 will have this setting enabled by default, and cannot disable it. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20strict_service_token_auth%20%3E%20(schema)>) ui\_read\_only\_toggle\_reason: optional string A description of the reason why the UI read only field is being toggled. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20ui_read_only_toggle_reason%20%3E%20(schema)>) user\_seat\_expiration\_inactive\_time: optional string The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Minimum value for this setting is 1 month (730h). Must be in the format `300ms` or `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20user_seat_expiration_inactive_time%20%3E%20(schema)>) warp\_auth\_non\_browser\_401: optional boolean When enabled, unsuccessful WARP authentication requests with a non-HTML Accept header return a 401 response instead of redirecting to the login page. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20warp_auth_non_browser_401%20%3E%20(schema)>) warp\_auth\_session\_duration: optional string The amount of time that tokens issued for applications will be valid. Must be in the format `30m` or `2h45m`. Valid time units are: m, h. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20warp_auth_session_duration%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(network%20schema)%20%3E%20(property)%20messages>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(network%20schema)%20%3E%20(property)%20success>)

result: optional Organization { allow\_authenticate\_via\_warp, auth\_domain, auto\_redirect\_to\_identity, 16 more }

allow\_authenticate\_via\_warp: optional boolean When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value. Link to this property auth\_domain: optional string The unique subdomain assigned to your Zero Trust organization. If omitted on creation, a unique subdomain is auto-generated in the format adjective-noun-hex4 (e.g. frosty-moon-7a3b.cloudflareaccess.com). Link to this property auto\_redirect\_to\_identity: optional boolean When set to true, users skip the identity provider selection step during login. Link to this property

custom\_pages: optional object {forbidden, identity\_denied }

Link to this property deny\_unmatched\_requests: optional boolean Determines whether to deny all requests to Cloudflare-protected resources that lack an associated Access application. If enabled, you must explicitly configure an Access application and policy to allow traffic to your Cloudflare-protected resources. For domains you want to be public across all subdomains, add the domain to the deny_unmatched_requests_exempted_zone_names array. Link to this property deny\_unmatched\_requests\_exempted\_zone\_names: optional array of string Contains zone names to exempt from the deny_unmatched_requests feature. Requests to a subdomain in an exempted zone will block unauthenticated traffic by default if there is a configured Access application and policy that matches the request. Link to this property is\_ui\_read\_only: optional boolean Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled. Link to this property

Link to this property

One of the following: "totp" Link to this property "biometrics" Link to this property "security\_key" Link to this property "piv\_key" Link to this property "ssh\_fido2\_key" Link to this property

Link to this property

mfa\_piv\_key\_requirements: optional object {pin\_policy, require\_fips\_device, ssh\_key\_size, 2 more } Configures PIV key requirements for MFA using hardware security keys.

One of the following: "never" Link to this property "once" Link to this property "always" Link to this property

Link to this property require\_fips\_device: optional boolean Requires the PIV key to be stored on a FIPS 140-2 Level 1 or higher validated device. Link to this property

One of the following: 256 Link to this property 384 Link to this property 521 Link to this property 2048 Link to this property 3072 Link to this property 4096 Link to this property

Link to this property

ssh\_key\_type: optional array of "ecdsa"or "ed25519"or "rsa" Specifies the allowed SSH key types. Valid values are ecdsa, ed25519, and rsa.

One of the following: "ecdsa" Link to this property "ed25519" Link to this property "rsa" Link to this property

Link to this property

One of the following: "never" Link to this property "always" Link to this property "cached" Link to this property

Link to this property

Link to this property mfa\_required\_for\_all\_apps: optional boolean Determines whether global MFA settings apply to applications by default. The organization must have MFA enabled with at least one authentication method and a session duration configured. Note: ‘allowed\_authenticators’ cannot contain only the infrastructure SSH authenticators (‘piv\_key’ and ‘ssh\_fido2\_key’) if the organization has any non-infrastructure applications. Link to this property name: optional string The name of your Zero Trust organization. When omitted on creation, defaults to the provided auth\_domain; when both are omitted, defaults to the auto-generated subdomain slug (e.g. frosty-moon-7a3b). Link to this property

action: "disable"or "delete" The action applied to an inactive service token.

One of the following: "disable" Link to this property "delete" Link to this property

Link to this property session\_duration: optional string The amount of time that tokens issued for applications will be valid. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h. Link to this property strict\_service\_token\_auth: optional boolean Enables new behaviors for requests made with Access service tokens. Unauthorized requests emit audit logs, and return a 401 or 403 status code in the response instead of redirecting to the login page. Successful requests no longer receive a CF\_Authorization cookie in the response. Zero Trust organizations created on or after October 5, 2026 will have this setting enabled by default, and cannot disable it. Link to this property ui\_read\_only\_toggle\_reason: optional string A description of the reason why the UI read only field is being toggled. Link to this property user\_seat\_expiration\_inactive\_time: optional string The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Minimum value for this setting is 1 month (730h). Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h. Link to this property warp\_auth\_non\_browser\_401: optional boolean When enabled, unsuccessful WARP authentication requests with a non-HTML Accept header return a 401 response instead of redirecting to the login page. Link to this property warp\_auth\_session\_duration: optional string The amount of time that tokens issued for applications will be valid. Must be in the format 30m or 2h45m. Valid time units are: m, h. Link to this property

[Link to this property](<#(resource)%20zero_trust.organizations%20%3E%20(method)%20update%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Update your Zero Trust organization HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/$ACCOUNTS_OR_ZONES/$ACCOUNT_OR_ZONE_ID/access/organizations \ -X PUT \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ -d '{ "auth_domain": "test.cloudflareaccess.com", "deny_unmatched_requests_exempted_zone_names": [ "example.com" ], "name": "Widget Corps Internal Applications", "session_duration": "24h", "strict_service_token_auth": true, "ui_read_only_toggle_reason": "Temporarily turn off the UI read only lock to make a change via the UI", "user_seat_expiration_inactive_time": "730h", "warp_auth_session_duration": "24h" }' ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "allow_authenticate_via_warp": true, "auth_domain": "test.cloudflareaccess.com", "auto_redirect_to_identity": true, "created_at": "2014-01-01T05:20:00.12345Z", "custom_pages": { "forbidden": "699d98642c564d2e855e9661899b7252", "identity_denied": "699d98642c564d2e855e9661899b7252" }, "deny_unmatched_requests": true, "deny_unmatched_requests_exempted_zone_names": [ "example.com" ], "is_ui_read_only": true, "login_design": { "background_color": "#c5ed1b", "footer_text": "This is an example description.", "header_text": "This is an example description.", "logo_path": "https://example.com/logo.png", "text_color": "#c5ed1b" }, "mfa_config": { "allowed_authenticators": [ "totp", "biometrics", "security_key" ], "amr_matching_session_duration": "12h", "required_aaguids": "2fc0579f-8113-47ea-b116-bb5a8db9202a", "session_duration": "24h" }, "mfa_piv_key_requirements": { "pin_policy": "always", "require_fips_device": true, "ssh_key_size": [ 256, 2048 ], "ssh_key_type": [ "ecdsa", "rsa" ], "touch_policy": "always" }, "mfa_required_for_all_apps": false, "name": "Widget Corps Internal Applications", "service_token_inactivity": { "action": "disable", "enabled": true, "inactivity_threshold_days": 30 }, "session_duration": "24h", "strict_service_token_auth": true, "ui_read_only_toggle_reason": "Temporarily turn off the UI read only lock to make a change via the UI", "updated_at": "2014-01-01T05:20:00.12345Z", "user_seat_expiration_inactive_time": "730h", "warp_auth_non_browser_401": false, "warp_auth_session_duration": "24h" } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "allow_authenticate_via_warp": true, "auth_domain": "test.cloudflareaccess.com", "auto_redirect_to_identity": true, "created_at": "2014-01-01T05:20:00.12345Z", "custom_pages": { "forbidden": "699d98642c564d2e855e9661899b7252", "identity_denied": "699d98642c564d2e855e9661899b7252" }, "deny_unmatched_requests": true, "deny_unmatched_requests_exempted_zone_names": [ "example.com" ], "is_ui_read_only": true, "login_design": { "background_color": "#c5ed1b", "footer_text": "This is an example description.", "header_text": "This is an example description.", "logo_path": "https://example.com/logo.png", "text_color": "#c5ed1b" }, "mfa_config": { "allowed_authenticators": [ "totp", "biometrics", "security_key" ], "amr_matching_session_duration": "12h", "required_aaguids": "2fc0579f-8113-47ea-b116-bb5a8db9202a", "session_duration": "24h" }, "mfa_piv_key_requirements": { "pin_policy": "always", "require_fips_device": true, "ssh_key_size": [ 256, 2048 ], "ssh_key_type": [ "ecdsa", "rsa" ], "touch_policy": "always" }, "mfa_required_for_all_apps": false, "name": "Widget Corps Internal Applications", "service_token_inactivity": { "action": "disable", "enabled": true, "inactivity_threshold_days": 30 }, "session_duration": "24h", "strict_service_token_auth": true, "ui_read_only_toggle_reason": "Temporarily turn off the UI read only lock to make a change via the UI", "updated_at": "2014-01-01T05:20:00.12345Z", "user_seat_expiration_inactive_time": "730h", "warp_auth_non_browser_401": false, "warp_auth_session_duration": "24h" } } ```