Update your Zero Trust organization
Updates the configuration for your Zero Trust organization.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Accepted Permissions (at least one required)
Parameters
The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value.
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.
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.
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.
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.
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.
A description of the reason why the UI read only field is being toggled.
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.
Update your Zero Trust organization
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
organization = client.zero_trust.organizations.update(
account_id="account_id",
)
print(organization.auto_redirect_to_identity){
"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"
],
"session_duration": "24h"
},
"mfa_required_for_all_apps": false,
"name": "Widget Corps Internal Applications",
"session_duration": "24h",
"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_session_duration": "24h"
}
}Returns Examples
{
"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"
],
"session_duration": "24h"
},
"mfa_required_for_all_apps": false,
"name": "Widget Corps Internal Applications",
"session_duration": "24h",
"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_session_duration": "24h"
}
}