Sets up a Zero Trust organization for your account.
/accounts/{identifier}/access/organizations
post
Zero Trust organization
zero-trust-organization-create-your-zero-trust-organization
nullnull[
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"auth_domain": {
"description": "The unique subdomain assigned to your Zero Trust organization.",
"example": "test.cloudflareaccess.com",
"type": "string"
},
"auto_redirect_to_identity": {
"default": false,
"description": "When set to `true`, users skip the identity provider selection step during login.",
"type": "boolean"
},
"is_ui_read_only": {
"description": "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",
"type": "boolean"
},
"login_design": {
"properties": {
"background_color": {
"description": "The background color on your login page.",
"example": "#c5ed1b",
"type": "string"
},
"footer_text": {
"description": "The text at the bottom of your login page.",
"example": "This is an example description.",
"type": "string"
},
"header_text": {
"description": "The text at the top of your login page.",
"example": "This is an example description.",
"type": "string"
},
"logo_path": {
"description": "The URL of the logo on your login page.",
"example": "https://example.com/logo.png",
"type": "string"
},
"text_color": {
"description": "The text color on your login page.",
"example": "#c5ed1b",
"type": "string"
}
}
},
"name": {
"description": "The name of your Zero Trust organization.",
"example": "Widget Corps Internal Applications",
"type": "string"
},
"session_duration": {
"description": "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.",
"example": "24h",
"type": "string"
},
"ui_read_only_toggle_reason": {
"description": "A description of the reason why the UI read only field is being toggled.",
"example": "Temporarily turn off the UI read only lock to make a change via the UI",
"type": "string"
},
"user_seat_expiration_inactive_time": {
"description": "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`.",
"example": "720h",
"type": "string"
}
},
"required": [
"name",
"auth_domain"
]
}
}
},
"required": true
}{
"201": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"auth_domain": {
"description": "The unique subdomain assigned to your Zero Trust organization.",
"example": "test.cloudflareaccess.com",
"type": "string"
},
"auto_redirect_to_identity": {
"default": false,
"description": "When set to `true`, users skip the identity provider selection step during login.",
"type": "boolean"
},
"created_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"custom_pages": {
"properties": {
"forbidden": {
"description": "The uid of the custom page to use when a user is denied access after failing a non-identity rule.",
"example": "699d98642c564d2e855e9661899b7252",
"type": "string"
},
"identity_denied": {
"description": "The uid of the custom page to use when a user is denied access.",
"example": "699d98642c564d2e855e9661899b7252",
"type": "string"
}
}
},
"is_ui_read_only": {
"description": "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",
"type": "boolean"
},
"login_design": {
"properties": {
"background_color": {
"description": "The background color on your login page.",
"example": "#c5ed1b",
"type": "string"
},
"footer_text": {
"description": "The text at the bottom of your login page.",
"example": "This is an example description.",
"type": "string"
},
"header_text": {
"description": "The text at the top of your login page.",
"example": "This is an example description.",
"type": "string"
},
"logo_path": {
"description": "The URL of the logo on your login page.",
"example": "https://example.com/logo.png",
"type": "string"
},
"text_color": {
"description": "The text color on your login page.",
"example": "#c5ed1b",
"type": "string"
}
}
},
"name": {
"description": "The name of your Zero Trust organization.",
"example": "Widget Corps Internal Applications",
"type": "string"
},
"session_duration": {
"description": "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.",
"example": "24h",
"type": "string"
},
"ui_read_only_toggle_reason": {
"description": "A description of the reason why the UI read only field is being toggled.",
"example": "Temporarily turn off the UI read only lock to make a change via the UI",
"type": "string"
},
"updated_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user_seat_expiration_inactive_time": {
"description": "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`.",
"example": "720h",
"type": "string"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "Create your Zero Trust organization response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "Create your Zero Trust organization response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]