> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/automation/runbooks/runbook-references/org/devices/add-autopilot-device.md).

# Add Autopilot Device

Register a Windows device in Windows Autopilot

### Description

Registers a Windows device in Windows Autopilot from its serial number and hardware hash, as collected with Get-WindowsAutopilotInfo. Optionally a group tag is set during the import and the runbook waits until the import has finished.

### Location

Organization → Devices → Add Autopilot Device

**Full Runbook name**

rjgit-org\_devices\_add-autopilot-device

### Details

| Property         | Value                               |
| ---------------- | ----------------------------------- |
| Version          | 1.0.2                               |
| Required modules | RealmJoin.RunbookHelper (>= 0.8.10) |
| Schedulable      | no                                  |

### Permissions

#### Application permissions

* **Type**: Microsoft Graph
  * DeviceManagementServiceConfig.ReadWrite.All
    * *Imports the serial number and hardware hash as Autopilot device and polls the import job*
  * User.Read.All *(optional — feature: User assignment)*
    * *Resolves the assigned user's UPN when AssignedUser is provided*

### Parameters

#### SerialNumber

Serial number of the device as reported by Get-WindowsAutopilotInfo.

| Property            | Value         |
| ------------------- | ------------- |
| Required            | true          |
| Default Value       |               |
| Type                | String        |
| Portal display name | Serial number |

#### HardwareIdentifier

Hardware hash of the device as reported by Get-WindowsAutopilotInfo.

| Property            | Value         |
| ------------------- | ------------- |
| Required            | true          |
| Default Value       |               |
| Type                | String        |
| Portal display name | Hardware hash |

#### AssignedUser

User to assign during the import. Microsoft no longer accepts this, so leave it empty.

| Property            | Value                                  |
| ------------------- | -------------------------------------- |
| Required            | false                                  |
| Default Value       |                                        |
| Type                | String                                 |
| Portal display name | Assign device to this user (optional)  |
| Hidden in portal    | yes (preset via runbook customization) |

#### Wait

Keeps the runbook running until Autopilot has processed the import, so the result shows in the output.

| Property            | Value                          |
| ------------------- | ------------------------------ |
| Required            | false                          |
| Default Value       | True                           |
| Type                | Boolean                        |
| Portal display name | Wait for the import to finish? |

#### GroupTag

Group tag to set on the device, for example to steer it into an Autopilot profile. Leave empty for none.

| Property            | Value     |
| ------------------- | --------- |
| Required            | false     |
| Default Value       |           |
| Type                | String    |
| Portal display name | Group tag |

[Back to Runbook Reference overview](/automation/runbooks/runbook-references.md)


---

# 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://docs.realmjoin.com/automation/runbooks/runbook-references/org/devices/add-autopilot-device.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.