Update your Zero Trust organization
client.zeroTrust.organizations.update(OrganizationUpdateParams { account_id, zone_id, allow_authenticate_via_warp, 14 more } params, RequestOptionsoptions?): Organization { allow_authenticate_via_warp, auth_domain, auto_redirect_to_identity, 12 more }
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:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Update your Zero Trust organization
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});
const organization = await client.zeroTrust.organizations.update({ account_id: 'account_id' });
console.log(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"
}
}