Skip to content

[ZT] Windows multi-user support #18645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Dec 13, 2024
Merged

[ZT] Windows multi-user support #18645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d64fa39
alphabetize parameters
ranbel Dec 9, 2024
db88844
remove limitation
ranbel Dec 9, 2024
fa7ecf3
new multi-user page
ranbel Dec 9, 2024
5827f4f
update section title
ranbel Dec 9, 2024
81ddc26
update configs MDM example
ranbel Dec 10, 2024
cd5b011
add MDM parameters
ranbel Dec 10, 2024
3c817f4
update flowchart
ranbel Dec 10, 2024
eb141ee
break out top-level parameters
ranbel Dec 12, 2024
8f882ca
add beta
ranbel Dec 12, 2024
946a743
clarify mode switch behavior
ranbel Dec 12, 2024
479f4c9
Update src/content/docs/cloudflare-one/connections/connect-devices/wa…
ranbel Dec 13, 2024
875adc9
simplify flowchart
ranbel Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
166 changes: 97 additions & 69 deletions ...e-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,60 +42,36 @@ Instructs the client to direct all DNS queries to a specific [Gateway DNS locati

**Value:** Your <GlossaryTooltip term="DoH subdomain">DoH subdomain</GlossaryTooltip>.

## Optional fields
## Organization parameters

### `service_mode`

Allows you to choose the operational mode of the client.

**Value Type:** `string`

**Value:**

* `warp` — (default) [Gateway with WARP](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#gateway-with-warp-default).
* `1dot1` — [Gateway with DoH](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#gateway-with-doh).
* `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,
```xml
<key>service_mode</key>
<string>proxy</string>
<key>proxy_port</key>
<integer>44444</integer>
```
* `postureonly` — [Device Information Only](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#device-information-only).
You can use the following parameters to configure a specific Zero Trust organization.

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.

### `onboarding`

Controls the visibility of the onboarding screens that ask the user to review the privacy policy during an application's first launch.

**Value Type:** `boolean`

**Value:**

* `false` — Screens hidden.
* `true` — (default) Screens visible.

### `switch_locked`

Allows the user to turn off the WARP switch and disconnect the client.
### `auth_client_id`

**Value Type:** `boolean`
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).
Requires the `auth_client_secret` parameter.

**Value:**
**Value Type:** `string`

* `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.
* `true` — The user is prevented from turning off the switch. The WARP client will automatically start in the connected state.
**Value:** Client ID of the service token.

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.
Example configuration:

:::note
```xml
<key>auth_client_id</key>
<string>88bf3b6d86161464f6509f7219099e57.access</string>
<key>auth_client_secret</key>
<string>bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5</string>
```

### `auth_client_secret`

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`.
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).
Requires the `auth_client_id` parameter.

**Value Type:** `string`

:::
**Value:** Client Secret of the service token.

### `auto_connect`

Expand All @@ -113,16 +89,25 @@ If switch has been turned off by user, the client will automatically turn itself
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`.
:::

### `support_url`

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.
### `display_name`

Identifies a Zero Trust organization in the WARP GUI when WARP is deployed with [multiple organizations](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/switch-organizations/). Required if the `organization` parameter is specified within a [`configs` array](#configs).

**Value Type:** `string`

**Value:** Organization nickname shown to users in the WARP GUI (for example, `Test environment`).

### `onboarding`

Controls the visibility of the onboarding screens that ask the user to review the privacy policy during an application's first launch.

**Value Type:** `boolean`

**Value:**

* `https://<support.example.com>` — Use an `https://` link to open your company's internal help site.
* `mailto:<[email protected]>` — Use a `mailto:` link to open your default mail client.
* `false` — Screens hidden.
* `true` — (default) Screens visible.

### `override_api_endpoint`

Expand Down Expand Up @@ -160,45 +145,88 @@ This functionality is intended for use with a Cloudflare China local network par

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.

### `unique_client_id`
### `service_mode`

Assigns a unique identifier to the device for the [device UUID posture check](/cloudflare-one/identity/devices/warp-client-checks/device-uuid).
Allows you to choose the operational mode of the client.

**Value Type:** `string`

**Value:** UUID for the device (for example, `496c6124-db89-4735-bc4e-7f759109a6f1`).
**Value:**

### `auth_client_id`
* `warp` — (default) [Gateway with WARP](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#gateway-with-warp-default).
* `1dot1` — [Gateway with DoH](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#gateway-with-doh).
* `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,
```xml
<key>service_mode</key>
<string>proxy</string>
<key>proxy_port</key>
<integer>44444</integer>
```
* `postureonly` — [Device Information Only](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/#device-information-only).

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).
Requires the `auth_client_secret` parameter.
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.


### `support_url`

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.

**Value Type:** `string`

**Value:** Client ID of the service token.
**Value:**

Example configuration:
* `https://<support.example.com>` — Use an `https://` link to open your company's internal help site.
* `mailto:<[email protected]>` — Use a `mailto:` link to open your default mail client.

```xml
<key>auth_client_id</key>
<string>88bf3b6d86161464f6509f7219099e57.access</string>
<key>auth_client_secret</key>
<string>bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5</string>
```

### `auth_client_secret`
### `switch_locked`

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).
Requires the `auth_client_id` parameter.
Allows the user to turn off the WARP switch and disconnect the client.

**Value Type:** `string`
**Value Type:** `boolean`

**Value:** Client Secret of the service token.
**Value:**

### `display_name`
* `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.
* `true` — The user is prevented from turning off the switch. The WARP client will automatically start in the connected state.

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.

:::note
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`.
:::

### `unique_client_id`

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.
Assigns a unique identifier to the device for the [device UUID posture check](/cloudflare-one/identity/devices/warp-client-checks/device-uuid).

**Value Type:** `string`

**Value:** Configuration name shown in the GUI (for example, `Test environment`).
**Value:** UUID for the device (for example, `496c6124-db89-4735-bc4e-7f759109a6f1`).

## Top-level parameters

Top-level parameters determine how WARP manages device registrations.

### `configs`

Allows a user to [switch between Zero Trust organizations](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/switch-organizations/) in the WARP client GUI. The `configs` array is also required when using another [top-level parameter](#top-level-parameters) such as `multi_user` or `pre_login`, even if only one organization is specified.

**Value Type:** `array`

**Value:** An array containing one or more Zero Trust organizations.

### `multi_user`

Enables multiple user registrations on a Windows device.

**Value Type:** `boolean`

**Value:**

* `false` — (default) Only one WARP registration is stored per device. After a user logs in to WARP, their settings and identity will apply to all traffic from the device.
* `true` — Each Windows user has their own WARP registration. For more information, refer to [Multiple users on a Windows device](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/).

### `pre_login`

Allows WARP to connect with a service token before a user completes the initial Windows login. For more information, refer to [Connect WARP before Windows login](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-prelogin/).
110 changes: 58 additions & 52 deletions ...ections/connect-devices/warp/deployment/mdm-deployment/switch-organizations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,32 +44,35 @@ An MDM file supports a maximum of 25 configurations. The following example inclu
<TabItem label="Windows">

```xml
<array>
<dict>
<key>organization</key>
<string>mycompany</string>
<key>display_name</key>
<string>Production environment</string>
</dict>
<dict>
<key>organization</key>
<string>mycompany</string>
<key>override_api_endpoint</key>
<string>203.0.113.0</string>
<key>override_doh_endpoint</key>
<string>203.0.113.0</string>
<key>override_warp_endpoint</key>
<string>203.0.113.0:2408</string>
<key>display_name</key>
<string>Cloudflare China network</string>
</dict>
<dict>
<key>organization</key>
<string>test-org</string>
<key>display_name</key>
<string>Test environment</string>
</dict>
</array>
<dict>
<key>configs</key>
<array>
<dict>
<key>organization</key>
<string>mycompany</string>
<key>display_name</key>
<string>Production environment</string>
</dict>
<dict>
<key>organization</key>
<string>mycompany</string>
<key>override_api_endpoint</key>
<string>203.0.113.0</string>
<key>override_doh_endpoint</key>
<string>203.0.113.0</string>
<key>override_warp_endpoint</key>
<string>203.0.113.0:2408</string>
<key>display_name</key>
<string>Cloudflare China network</string>
</dict>
<dict>
<key>organization</key>
<string>test-org</string>
<key>display_name</key>
<string>Test environment</string>
</dict>
</array>
</dict>
```

</TabItem>
Expand All @@ -89,32 +92,35 @@ An MDM file supports a maximum of 25 configurations. The following example inclu
<TabItem label="Linux">

```xml
<array>
<dict>
<key>organization</key>
<string>mycompany</string>
<key>display_name</key>
<string>Production environment</string>
</dict>
<dict>
<key>organization</key>
<string>mycompany</string>
<key>override_api_endpoint</key>
<string>203.0.113.0</string>
<key>override_doh_endpoint</key>
<string>203.0.113.0</string>
<key>override_warp_endpoint</key>
<string>203.0.113.0:2408</string>
<key>display_name</key>
<string>Cloudflare China network</string>
</dict>
<dict>
<key>organization</key>
<string>test-org</string>
<key>display_name</key>
<string>Test environment</string>
</dict>
</array>
<dict>
<key>configs</key>
<array>
<dict>
<key>organization</key>
<string>mycompany</string>
<key>display_name</key>
<string>Production environment</string>
</dict>
<dict>
<key>organization</key>
<string>mycompany</string>
<key>override_api_endpoint</key>
<string>203.0.113.0</string>
<key>override_doh_endpoint</key>
<string>203.0.113.0</string>
<key>override_warp_endpoint</key>
<string>203.0.113.0:2408</string>
<key>display_name</key>
<string>Cloudflare China network</string>
</dict>
<dict>
<key>organization</key>
<string>test-org</string>
<key>display_name</key>
<string>Test environment</string>
</dict>
</array>
</dict>
```

</TabItem> </Tabs>
Expand Down
Loading
Loading