Zero TrustZero Trust Organization

Update your Zero Trust organization

PUT
Updates the configuration for your Zero Trust organization.

Path parameters

identifierstringRequired

Request

This endpoint expects an object.
auth_domain
stringOptional
The unique subdomain assigned to your Zero Trust organization.
auto_redirect_to_identity
booleanOptional

When set to true, users skip the identity provider selection step during login.

custom_pages
objectOptional
is_ui_read_only
booleanOptional
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.
login_design
objectOptional
name
stringOptional
The name of your Zero Trust organization.
session_duration
stringOptional

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.

ui_read_only_toggle_reason
stringOptional
A description of the reason why the UI read only field is being toggled.
user_seat_expiration_inactive_time
stringOptional

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. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h.

Response

This endpoint returns an object
result
objectOptional
PUT
1curl -X PUT https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/organizations \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "auth_domain": "test.cloudflareaccess.com",
6  "custom_pages": {
7    "forbidden": "699d98642c564d2e855e9661899b7252",
8    "identity_denied": "699d98642c564d2e855e9661899b7252"
9  },
10  "login_design": {
11    "background_color": "#c5ed1b",
12    "footer_text": "This is an example description.",
13    "header_text": "This is an example description.",
14    "logo_path": "https://example.com/logo.png",
15    "text_color": "#c5ed1b"
16  },
17  "name": "Widget Corps Internal Applications",
18  "session_duration": "24h",
19  "ui_read_only_toggle_reason": "Temporarily turn off the UI read only lock to make a change via the UI",
20  "user_seat_expiration_inactive_time": "720h"
21}'
200Updated
1{
2  "result": {
3    "auth_domain": "test.cloudflareaccess.com",
4    "created_at": "2014-01-01T05:20:00.12345Z",
5    "custom_pages": {
6      "forbidden": "699d98642c564d2e855e9661899b7252",
7      "identity_denied": "699d98642c564d2e855e9661899b7252"
8    },
9    "login_design": {
10      "background_color": "#c5ed1b",
11      "footer_text": "This is an example description.",
12      "header_text": "This is an example description.",
13      "logo_path": "https://example.com/logo.png",
14      "text_color": "#c5ed1b"
15    },
16    "name": "Widget Corps Internal Applications",
17    "session_duration": "24h",
18    "ui_read_only_toggle_reason": "Temporarily turn off the UI read only lock to make a change via the UI",
19    "updated_at": "2014-01-01T05:20:00.12345Z",
20    "user_seat_expiration_inactive_time": "720h"
21  }
22}
Built with