Skip to content

Commit

Permalink
#22075 API design (#22398)
Browse files Browse the repository at this point in the history
  • Loading branch information
rachaelshaw authored Sep 25, 2024
1 parent 6c838d3 commit 1abc905
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/Configuration/yaml-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,8 @@ controls:
enable: true
mode: voluntary
webhook_url: https://example.org/webhook_handler
windows_migration: # Available in Fleet Premium
enable: true
# paths are relative to default.yml or teams/team-name.yml
```

Expand Down Expand Up @@ -309,7 +311,13 @@ The `macos_migration` section lets you control the [end user migration workflow]
- `mode` specifies whether the end user initiates migration (`voluntary`) or they're nudged every 15-20 minutes to migrate (`forced`) (default: `""`).
- `webhook_url` is the URL that Fleet sends a webhook to when the end user selects **Start**. Receive this webhook using your automation tool (ex. Tines) to unenroll your end users from your old MDM solution.

Can only be configure for all teams (`default.yml`).
Can only be configured for all teams (`default.yml`).

#### windows_migration

The `windows_migration` section lets you control migration for Windows hosts that enrolled to your old MDM solution.

- `enable` specifies whether or not to enable automatic migration for Windows hosts with fleetd (default: `false`)

### software

Expand Down
19 changes: 19 additions & 0 deletions docs/REST API/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1234,6 +1234,9 @@ Modifies the Fleet's configuration with the supplied information.
"mode": "voluntary",
"webhook_url": "https://webhook.example.com"
},
"windows_migration": {
"enable": false
},
"macos_setup": {
"bootstrap_package": "",
"enable_end_user_authentication": false,
Expand Down Expand Up @@ -1711,6 +1714,7 @@ _Available in Fleet Premium._
| ipados_updates | object | See [`mdm.ipados_updates`](#mdm-ipados-updates). |
| windows_updates | object | See [`mdm.window_updates`](#mdm-windows-updates). |
| macos_migration | object | See [`mdm.macos_migration`](#mdm-macos-migration). |
| windows_migration | object | See [`mdm.windows_migration`](#mdm-windows-migration). |
| macos_setup | object | See [`mdm.macos_setup`](#mdm-macos-setup). |
| macos_settings | object | See [`mdm.macos_settings`](#mdm-macos-settings). |
| windows_settings | object | See [`mdm.windows_settings`](#mdm-windows-settings). |
Expand Down Expand Up @@ -1783,6 +1787,18 @@ _Available in Fleet Premium._

<br/>

##### mdm.windows_migration

_Available in Fleet Premium._

`mdm.windows_migration` is an object with the following structure:

| Name | Type | Description |
| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enable | boolean | Whether to enable automatic migration via fleetd for devices migrating from your old MDM solution. |

<br/>

##### mdm.macos_setup

_Available in Fleet Premium._
Expand Down Expand Up @@ -1862,6 +1878,9 @@ _Available in Fleet Premium._
"mode": "voluntary",
"webhook_url": "https://webhook.example.com"
},
"windows_migration": {
"enable": false
},
"macos_setup": {
"bootstrap_package": "",
"enable_end_user_authentication": false,
Expand Down

0 comments on commit 1abc905

Please sign in to comment.