Update your Zero Trust organization

PUT

https://api.cloudflare.com/client/v4/zones/{identifier}/access/organizations

Last modified:2022-12-16 13:48:37

Updates the configuration for your Zero Trust organization.

Request

Path Params

identifier

string

required

Body Params application/json

auth_domain

string

optional

The unique subdomain assigned to your Zero Trust organization.

Example:

test.cloudflareaccess.com

is_ui_read_only

boolean

optional

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.

Example:

false

login_design

object (login_design)

optional

background_color

string

optional

The background color on your login page.

Example:

#c5ed1b

footer_text

string

optional

The text at the bottom of your login page.

Example:

This is an example description.

header_text

string

optional

The text at the top of your login page.

Example:

This is an example description.

logo_path

string

optional

The URL of the logo on your login page.

Example:

https://example.com/logo.png

text_color

string

optional

The text color on your login page.

Example:

#c5ed1b

name

string

optional

The name of your Zero Trust organization.

Example:

Widget Corps Internal Applications

Example

{
    "auth_domain": "test.cloudflareaccess.com",
    "is_ui_read_only": "false",
    "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"
    },
    "name": "Widget Corps Internal Applications"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/zones//access/organizations' \
--header 'Content-Type: application/json' \
--data-raw '{
    "auth_domain": "test.cloudflareaccess.com",
    "is_ui_read_only": "false",
    "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"
    },
    "name": "Widget Corps Internal Applications"
}'

Responses

🟢200Update your Zero Trust organization response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object (Cloudflare Client API_organizations)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "auth_domain": "test.cloudflareaccess.com",
        "created_at": "2014-01-01T05:20:00.12345Z",
        "is_ui_read_only": "false",
        "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"
        },
        "name": "Widget Corps Internal Applications",
        "updated_at": "2014-01-01T05:20:00.12345Z"
    },
    "success": true
}

🟢200Update your Zero Trust organization response failure

Modified at 2022-12-16 13:48:37

Create your Zero Trust organization

Revoke all Access tokens for a user