You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters.mdx
+70-68Lines changed: 70 additions & 68 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,58 +44,32 @@ Instructs the client to direct all DNS queries to a specific [Gateway DNS locati
44
44
45
45
## Optional fields
46
46
47
-
### `service_mode`
47
+
### `auth_client_id`
48
48
49
-
Allows you to choose the operational mode of the client.
49
+
Enrolls the device in your Zero Trust organization using a [service token](/cloudflare-one/connections/connect-devices/warp/deployment/device-enrollment/#check-for-service-token).
50
+
Requires the `auth_client_secret` parameter.
50
51
51
52
**Value Type:**`string`
52
53
53
-
**Value:**
54
-
55
-
*`warp` — (default) [Gateway with WARP](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#gateway-with-warp-default).
56
-
*`1dot1` — [Gateway with DoH](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#gateway-with-doh).
57
-
*`proxy` — [Proxy mode](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#proxy-mode). Use the `proxy_port` parameter to specify the localhost SOCKS proxy port (between `0`-`66535`). For example,
58
-
```xml
59
-
<key>service_mode</key>
60
-
<string>proxy</string>
61
-
<key>proxy_port</key>
62
-
<integer>44444</integer>
63
-
```
64
-
*`postureonly` — [Device Information Only](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#device-information-only).
65
-
66
-
The service mode [Secure Web Gateway without DNS filtering](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#secure-web-gateway-without-dns-filtering) is not currently supported as a value and must be configured in Zero Trust.
67
-
68
-
### `onboarding`
69
-
70
-
Controls the visibility of the onboarding screens that ask the user to review the privacy policy during an application's first launch.
71
-
72
-
**Value Type:**`boolean`
73
-
74
-
**Value:**
75
-
76
-
*`false` — Screens hidden.
77
-
*`true` — (default) Screens visible.
78
-
79
-
### `switch_locked`
80
-
81
-
Allows the user to turn off the WARP switch and disconnect the client.
82
-
83
-
**Value Type:**`boolean`
84
-
85
-
**Value:**
86
-
87
-
*`false` — (default) The user is able to turn the switch on/off at their discretion. When the switch is off, the user will not have the ability to reach sites protected by Access that leverage certain device posture checks.
88
-
*`true` — The user is prevented from turning off the switch. The WARP client will automatically start in the connected state.
54
+
**Value:** Client ID of the service token.
89
55
90
-
On new deployments, you must also include the `auto_connect` parameter with at least a value of `0`. This will prevent clients from being deployed in the off state without a way for users to manually enable them.
This parameter replaces the old `enabled` property, which can no longer be used in conjunction with the new `switch_locked` and `auto_connect`. If you want to use these parameters, you must remove `enabled`.
67
+
Enrolls the device in your Zero Trust organization using a [service token](/cloudflare-one/connections/connect-devices/warp/deployment/device-enrollment/#check-for-service-token).
68
+
Requires the `auth_client_id` parameter.
96
69
70
+
**Value Type:**`string`
97
71
98
-
:::
72
+
**Value:** Client Secret of the service token.
99
73
100
74
### `auto_connect`
101
75
@@ -113,16 +87,26 @@ If switch has been turned off by user, the client will automatically turn itself
113
87
This parameter replaces the old `enabled` property, which can no longer be used in conjunction with the new `switch_locked` and `auto_connect`. If you want to use these parameters, you must remove `enabled`.
114
88
:::
115
89
116
-
### `support_url`
117
90
118
-
When the WARP client is deployed via MDM, the in-app **Send Feedback** button is disabled by default. This parameter allows you to re-enable the button and direct feedback towards your organization.
91
+
### `display_name`
92
+
93
+
When WARP is deployed with [multiple organizations or configurations](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/switch-organizations/), this parameter is used to identify each configuration in the GUI.
119
94
120
95
**Value Type:**`string`
121
96
97
+
**Value:** Configuration name shown in the GUI (for example, `Test environment`).
98
+
99
+
### `onboarding`
100
+
101
+
Controls the visibility of the onboarding screens that ask the user to review the privacy policy during an application's first launch.
102
+
103
+
**Value Type:**`boolean`
104
+
122
105
**Value:**
123
106
124
-
*`https://<support.example.com>` — Use an `https://` link to open your company's internal help site.
125
-
*`mailto:<[email protected]>` — Use a `mailto:` link to open your default mail client.
107
+
*`false` — Screens hidden.
108
+
*`true` — (default) Screens visible.
109
+
126
110
127
111
### `override_api_endpoint`
128
112
@@ -160,45 +144,63 @@ This functionality is intended for use with a Cloudflare China local network par
160
144
161
145
The string must be a valid IPv4 or IPv6 socket address (containing the IP address and port number), otherwise the WARP client will fail to parse the entire MDM file.
162
146
163
-
### `unique_client_id`
147
+
### `service_mode`
164
148
165
-
Assigns a unique identifier to the device for the [device UUID posture check](/cloudflare-one/identity/devices/warp-client-checks/device-uuid).
149
+
Allows you to choose the operational mode of the client.
166
150
167
151
**Value Type:**`string`
168
152
169
-
**Value:** UUID for the device (for example, `496c6124-db89-4735-bc4e-7f759109a6f1`).
153
+
**Value:**
170
154
171
-
### `auth_client_id`
155
+
*`warp` — (default) [Gateway with WARP](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#gateway-with-warp-default).
156
+
*`1dot1` — [Gateway with DoH](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#gateway-with-doh).
157
+
*`proxy` — [Proxy mode](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#proxy-mode). Use the `proxy_port` parameter to specify the localhost SOCKS proxy port (between `0`-`66535`). For example,
158
+
```xml
159
+
<key>service_mode</key>
160
+
<string>proxy</string>
161
+
<key>proxy_port</key>
162
+
<integer>44444</integer>
163
+
```
164
+
*`postureonly` — [Device Information Only](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#device-information-only).
172
165
173
-
Enrolls the device in your Zero Trust organization using a [service token](/cloudflare-one/connections/connect-devices/warp/deployment/device-enrollment/#check-for-service-token).
174
-
Requires the `auth_client_secret` parameter.
166
+
The service mode [Secure Web Gateway without DNS filtering](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#secure-web-gateway-without-dns-filtering) is not currently supported as a value and must be configured in Zero Trust.
167
+
168
+
169
+
### `support_url`
170
+
171
+
When the WARP client is deployed via MDM, the in-app **Send Feedback** button is disabled by default. This parameter allows you to re-enable the button and direct feedback towards your organization.
175
172
176
173
**Value Type:**`string`
177
174
178
-
**Value:** Client ID of the service token.
175
+
**Value:**
179
176
180
-
Example configuration:
177
+
*`https://<support.example.com>` — Use an `https://` link to open your company's internal help site.
178
+
*`mailto:<[email protected]>` — Use a `mailto:` link to open your default mail client.
Enrolls the device in your Zero Trust organization using a [service token](/cloudflare-one/connections/connect-devices/warp/deployment/device-enrollment/#check-for-service-token).
192
-
Requires the `auth_client_id` parameter.
183
+
Allows the user to turn off the WARP switch and disconnect the client.
193
184
194
-
**Value Type:**`string`
185
+
**Value Type:**`boolean`
195
186
196
-
**Value:** Client Secret of the service token.
187
+
**Value:**
197
188
198
-
### `display_name`
189
+
*`false` — (default) The user is able to turn the switch on/off at their discretion. When the switch is off, the user will not have the ability to reach sites protected by Access that leverage certain device posture checks.
190
+
*`true` — The user is prevented from turning off the switch. The WARP client will automatically start in the connected state.
199
191
200
-
When WARP is deployed with [multiple organizations or configurations](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/switch-organizations/), this parameter is used to identify each configuration in the GUI.
192
+
On new deployments, you must also include the `auto_connect` parameter with at least a value of `0`. This will prevent clients from being deployed in the off state without a way for users to manually enable them.
193
+
194
+
:::note
195
+
This parameter replaces the old `enabled` property, which can no longer be used in conjunction with the new `switch_locked` and `auto_connect`. If you want to use these parameters, you must remove `enabled`.
196
+
:::
197
+
198
+
### `unique_client_id`
199
+
200
+
Assigns a unique identifier to the device for the [device UUID posture check](/cloudflare-one/identity/devices/warp-client-checks/device-uuid).
201
201
202
202
**Value Type:**`string`
203
203
204
-
**Value:** Configuration name shown in the GUI (for example, `Test environment`).
204
+
**Value:** UUID for the device (for example, `496c6124-db89-4735-bc4e-7f759109a6f1`).
0 commit comments