> For the complete documentation index, see [llms.txt](https://documentation.2pintsoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.2pintsoftware.com/deployr/1.1/reference/step-definitions/register-with-autopilot.md).

# Register with Autopilot

The **Register with Autopilot** step adds the current computer to the Autopilot service (for Autopilot v1) or to the Intune list of corporate device IDs (for Autopilot v2).  Multiple options can be configured:

![](https://744643921-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJO9NLelA0RS8JB4i9oaQ%2Fuploads%2FusmIYHRejD55e394CYe7%2Fimage.png?alt=media\&token=e15bc011-1306-4ad7-a922-2e990f855f8a) &#x20;

With Autopilot v1, a group tag can be configured (not applicable for v2) and the step can be instructed to wait for the profile assignment to complete.  For either version, the device can be added to a specified Entra ID group.

If the device is already enrolled in Windows Autopilot (v1) or a corporate identifier already exists (v1), no additional actions will be performed for the device.

{% hint style="info" %}
If you're using the "Entra ID group name" option, ensure that the group is an Assigned type, not a Dynamic group. If you get errors about permissions, first confirm your API access using the link below, then ensure the group is not Dynamic.&#x20;
{% endhint %}

This requires configuring [Microsoft Graph API access](/deployr/1.1/getting-started/microsoft-graph-api-access.md).

This step must be run in the Full OS, it will not work while in WinPE.

### Simple Implementation Test

To test this step in a task sequence, once the requirements in Graph as linked to above are complete, create a new task sequence: Add -> Select from Template ->  Autopilot pre-provisioning

{% hint style="info" %}
The "Register with Autopilot" step does not require this template.  It can be added to any task sequence where it is still running in the Full OS to do additional steps. Just make sure the step is added into the Full OS part of the task sequence.
{% endhint %}

* Either update the Apply OS step or replace it with the Apply OS from cloud and configure.  In this example I replaced it and configured
  * Apply operating system from cloud
    * Set Continuation Method to "Use Audit mode"

<figure><img src="https://744643921-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJO9NLelA0RS8JB4i9oaQ%2Fuploads%2Fqemn09cu5k6E8es21KOG%2Fimage.png?alt=media&amp;token=81a24ee2-69cc-4411-a534-318a1659626e" alt=""><figcaption></figcaption></figure>

* Add a step in the "Full OS" section of the Task Sequence
  * Register with Autopilot
    * Optional, add the group tag

<figure><img src="https://744643921-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJO9NLelA0RS8JB4i9oaQ%2Fuploads%2F92GySJ4GlTLmbmthLaLc%2Fimage.png?alt=media&amp;token=9353e925-95ad-456b-9711-62bb8fe52a7a" alt=""><figcaption></figcaption></figure>

During the Task Sequence, the log will show it first is importing the ID, then loop until it confirms it has been imported

<figure><img src="https://744643921-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJO9NLelA0RS8JB4i9oaQ%2Fuploads%2FZlkoJmkyeNDlaUIHtyhU%2Fimage.png?alt=media&amp;token=597c3aad-21ba-4879-ad7a-e55c71be5838" alt=""><figcaption></figcaption></figure>

Once confirmed it imported (status = complete), it will then loop waiting for the profile assignment to be assigned.

<figure><img src="https://744643921-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJO9NLelA0RS8JB4i9oaQ%2Fuploads%2F40zER2musYkuzMXRBNPg%2Fimage.png?alt=media&amp;token=afaf98d3-ea4a-4a37-8e68-b730223bb306" alt=""><figcaption></figcaption></figure>

It will eventually report back status = assignedInSync and the step will end

<figure><img src="https://744643921-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJO9NLelA0RS8JB4i9oaQ%2Fuploads%2FxusX3wjnPxeQnawVNTFA%2Fimage.png?alt=media&amp;token=edb1dcc5-39b9-4b5a-838b-44646d8f4c0f" alt=""><figcaption></figcaption></figure>

After the task sequence completes successfully the device will be waiting at the Autopilot logon page:

<figure><img src="https://744643921-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJO9NLelA0RS8JB4i9oaQ%2Fuploads%2FBf2OxMxGtvzIkNIwUXrG%2Fimage.png?alt=media&amp;token=4a1a561d-20c4-4ad2-a2fc-65dacc0fe2bd" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.2pintsoftware.com/deployr/1.1/reference/step-definitions/register-with-autopilot.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
