Skip to content
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.

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

API docs: OTA enrollment profile #22457

Merged
merged 8 commits into from
Oct 1, 2024
Merged

API docs: OTA enrollment profile #22457

merged 8 commits into from
Oct 1, 2024

Conversation

noahtalerman
Copy link
Member

@noahtalerman noahtalerman commented Sep 27, 2024

  • Bring OTA enrollment profile endpoint into REST API docs b/c customer-deebradel is building on top of this endpoint to enroll BYOD iOS, iPadOS, and macOS hosts
  • OTA enrollment profile is used for team assignment
  • Manual enrollment profile is used for adding human-device mapping.
    • Update "Config-less fleetd agent deployment" guide to show an example

Wraps up docs for this story:

@noahtalerman
Copy link
Member Author

  • Bring OTA enrollment profile endpoint into REST API docs b/c customer-deebradel is building on top of this endpoint to enroll BYOD iOS, iPadOS, and macOS hosts
  • OTA enrollment profile is used for team assignment
  • Manual enrollment profile is used for adding human-device mapping.
    • Update "Config-less fleetd agent deployment" guide to show an example

Hey @roperzh what do you think? Does this make sense?

Also, when you get the chance, can you please review the profile examples in the guide for accuracy? https://github.com/fleetdm/fleet/pull/22457/files#diff-ce868727f41c94baa43620e8064b241148122f355fa53be0e691415a64ef36a8

Thanks!

spokanemac
spokanemac previously approved these changes Sep 27, 2024

The returned value is a signed `.mobileconfig` OTA enrollment profile. Install this profile on macOS, iOS, or iPadOS hosts to enroll them to a specific team in Fleet and turn on MDM features.

To turn enroll macOS hosts, turn on MDM features, and add [human-device mapping](#get-human-device-mapping), install the [manual enrollment profile](#get-manual-enrollment-profile) instead.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@noahtalerman should this be either "turn on" or "enroll"? Or is "turn enroll" some special terminology?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops! That's a typo. This should be "enroll." I fixed it.

docs/REST API/rest-api.md Outdated Show resolved Hide resolved
@noahtalerman
Copy link
Member Author

Hey @lukeheath when you get the chance, can you please give this PR a review?

Waiting for this PR to merge before we close the associated user story.

@noahtalerman noahtalerman merged commit beec753 into main Oct 1, 2024
5 checks passed
@noahtalerman noahtalerman deleted the api-docs-ota-profile branch October 1, 2024 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants