# Runbook References

### Runbook References

This section contains detailed documentation for all available RealmJoin Runbooks. The runbooks are automatically generated from the [realmjoin-runbooks](https://github.com/realmjoin/realmjoin-runbooks) repository and updated daily.

All runbooks are organized into different folders based on their area of application.

The following categories are currently available:

* Device
* Group
* Organization
* User

Each category contains multiple runbooks that are further divided into subcategories based on their functionality. The runbooks are listed in alphabetical order within each subcategory.

### RealmJoin Runbook overview

In the following, each runbook is listed along with a brief description or synopsis to give a clear understanding of its purpose and functionality. Also the document for each runbook contains information about permissions, where to find, notes, and parameters and further information in general.

#### Runbook categorie overview

| Category                                                       | Subcategory                                                                                                                                                                                                                                                                                                                                                                                                 |
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Device](/automation/runbooks/runbook-references/device.md)    | <p><a href="/pages/ghpNG7ZPd2z69KyFOaAS#device-avd">AVD</a><br><a href="/pages/ghpNG7ZPd2z69KyFOaAS#device-general">General</a><br><a href="/pages/ghpNG7ZPd2z69KyFOaAS#device-security">Security</a></p>                                                                                                                                                                                                   |
| [Group](/automation/runbooks/runbook-references/group.md)      | <p><a href="/pages/tHbZNIuXHSyDESHNjAiB#group-devices">Devices</a><br><a href="/pages/tHbZNIuXHSyDESHNjAiB#group-general">General</a><br><a href="/pages/tHbZNIuXHSyDESHNjAiB#group-mail">Mail</a><br><a href="/pages/tHbZNIuXHSyDESHNjAiB#group-teams">Teams</a></p>                                                                                                                                       |
| [Organization](/automation/runbooks/runbook-references/org.md) | <p><a href="/pages/cxPaXzntfYnNZwn8MTO4#org-applications">Applications</a><br><a href="/pages/cxPaXzntfYnNZwn8MTO4#org-devices">Devices</a><br><a href="/pages/cxPaXzntfYnNZwn8MTO4#org-general">General</a><br><a href="/pages/cxPaXzntfYnNZwn8MTO4#org-mail">Mail</a><br><a href="/pages/cxPaXzntfYnNZwn8MTO4#org-phone">Phone</a><br><a href="/pages/cxPaXzntfYnNZwn8MTO4#org-security">Security</a></p> |
| [User](/automation/runbooks/runbook-references/user.md)        | <p><a href="/pages/7JIzd6wMIUHk41qRYglm#user-avd">AVD</a><br><a href="/pages/7JIzd6wMIUHk41qRYglm#user-general">General</a><br><a href="/pages/7JIzd6wMIUHk41qRYglm#user-mail">Mail</a><br><a href="/pages/7JIzd6wMIUHk41qRYglm#user-phone">Phone</a><br><a href="/pages/7JIzd6wMIUHk41qRYglm#user-security">Security</a><br><a href="/pages/7JIzd6wMIUHk41qRYglm#user-userinfo">Userinfo</a></p>           |

#### Device Runbooks

* [AVD](/automation/runbooks/runbook-references/device.md#device-avd)
  * [Restart Host](/automation/runbooks/runbook-references/device/avd/restart-host.md)
  * [Toggle Drain Mode](/automation/runbooks/runbook-references/device/avd/toggle-drain-mode.md)
* [General](/automation/runbooks/runbook-references/device.md#device-general)
  * [Assign Groups By Template](/automation/runbooks/runbook-references/device/general/assign-groups-by-template.md)
  * [Change Grouptag](/automation/runbooks/runbook-references/device/general/change-grouptag.md)
  * [Check Device Compliance](/automation/runbooks/runbook-references/device/general/check-device-compliance.md)
  * [Check Updatable Assets](/automation/runbooks/runbook-references/device/general/check-updatable-assets.md)
  * [Enroll Updatable Assets](/automation/runbooks/runbook-references/device/general/enroll-updatable-assets.md)
  * [Outphase Device](/automation/runbooks/runbook-references/device/general/outphase-device.md)
  * [Remove Primary User](/automation/runbooks/runbook-references/device/general/remove-primary-user.md)
  * [Rename Device](/automation/runbooks/runbook-references/device/general/rename-device.md)
  * [Set Primary User](/automation/runbooks/runbook-references/device/general/set-primary-user.md)
  * [Unenroll Updatable Assets](/automation/runbooks/runbook-references/device/general/unenroll-updatable-assets.md)
  * [Wipe Device](/automation/runbooks/runbook-references/device/general/wipe-device.md)
* [Security](/automation/runbooks/runbook-references/device.md#device-security)
  * [Enable Or Disable Device](/automation/runbooks/runbook-references/device/security/enable-or-disable-device.md)
  * [Isolate Or Release Device](/automation/runbooks/runbook-references/device/security/isolate-or-release-device.md)
  * [Reset Mobile Device Pin](/automation/runbooks/runbook-references/device/security/reset-mobile-device-pin.md)
  * [Restrict Or Release Code Execution](/automation/runbooks/runbook-references/device/security/restrict-or-release-code-execution.md)
  * [Show Bitlocker Recovery Key](/automation/runbooks/runbook-references/device/security/show-bitlocker-recovery-key.md)
  * [Show Filevault Recovery Key](/automation/runbooks/runbook-references/device/security/show-filevault-recovery-key.md)
  * [Show Laps Password](/automation/runbooks/runbook-references/device/security/show-laps-password.md)

#### Group Runbooks

* [Devices](/automation/runbooks/runbook-references/group.md#group-devices)
  * [Check Updatable Assets](/automation/runbooks/runbook-references/group/devices/check-updatable-assets.md)
  * [Unenroll Updatable Assets (Scheduled)](/automation/runbooks/runbook-references/group/devices/unenroll-updatable-assets_scheduled.md)
* [General](/automation/runbooks/runbook-references/group.md#group-general)
  * [Add Or Remove Nested Group](/automation/runbooks/runbook-references/group/general/add-or-remove-nested-group.md)
  * [Add Or Remove Owner](/automation/runbooks/runbook-references/group/general/add-or-remove-owner.md)
  * [Add Or Remove User](/automation/runbooks/runbook-references/group/general/add-or-remove-user.md)
  * [Change Visibility](/automation/runbooks/runbook-references/group/general/change-visibility.md)
  * [List All Members](/automation/runbooks/runbook-references/group/general/list-all-members.md)
  * [List Owners](/automation/runbooks/runbook-references/group/general/list-owners.md)
  * [List User Devices](/automation/runbooks/runbook-references/group/general/list-user-devices.md)
  * [Remove Group](/automation/runbooks/runbook-references/group/general/remove-group.md)
  * [Rename Group](/automation/runbooks/runbook-references/group/general/rename-group.md)
* [Mail](/automation/runbooks/runbook-references/group.md#group-mail)
  * [Enable Or Disable External Mail](/automation/runbooks/runbook-references/group/mail/enable-or-disable-external-mail.md)
  * [Show Or Hide In Address Book](/automation/runbooks/runbook-references/group/mail/show-or-hide-in-address-book.md)
* [Teams](/automation/runbooks/runbook-references/group.md#group-teams)
  * [Archive Team](/automation/runbooks/runbook-references/group/teams/archive-team.md)

#### Organization Runbooks

* [Applications](/automation/runbooks/runbook-references/org.md#org-applications)
  * [Add Application Registration](/automation/runbooks/runbook-references/org/applications/add-application-registration.md)
  * [Delete Application Registration](/automation/runbooks/runbook-references/org/applications/delete-application-registration.md)
  * [Export Enterprise Application Users](/automation/runbooks/runbook-references/org/applications/export-enterprise-application-users.md)
  * [List Inactive Enterprise Applications](/automation/runbooks/runbook-references/org/applications/list-inactive-enterprise-applications.md)
  * [Report Application Registration](/automation/runbooks/runbook-references/org/applications/report-application-registration.md)
  * [Report Expiring Application Credentials (Scheduled)](/automation/runbooks/runbook-references/org/applications/report-expiring-application-credentials_scheduled.md)
  * [Update Application Registration](/automation/runbooks/runbook-references/org/applications/update-application-registration.md)
* [Devices](/automation/runbooks/runbook-references/org.md#org-devices)
  * [Add Autopilot Device](/automation/runbooks/runbook-references/org/devices/add-autopilot-device.md)
  * [Add Device Via Corporate Identifier](/automation/runbooks/runbook-references/org/devices/add-device-via-corporate-identifier.md)
  * [Auto Approve Driver Updates (Scheduled)](/automation/runbooks/runbook-references/org/devices/auto-approve-driver-updates_scheduled.md)
  * [Create Endpoint Analytics Baseline](/automation/runbooks/runbook-references/org/devices/create-endpoint-analytics-baseline.md)
  * [Dedup Device Names (Scheduled)](/automation/runbooks/runbook-references/org/devices/dedup-device-names_scheduled.md)
  * [Delete Stale Devices (Scheduled)](/automation/runbooks/runbook-references/org/devices/delete-stale-devices_scheduled.md)
  * [Get Bitlocker Recovery Key](/automation/runbooks/runbook-references/org/devices/get-bitlocker-recovery-key.md)
  * [Notify Users About Stale Devices (Scheduled)](/automation/runbooks/runbook-references/org/devices/notify-users-about-stale-devices_scheduled.md)
  * [Outphase Devices](/automation/runbooks/runbook-references/org/devices/outphase-devices.md)
  * [Report Devices Without Primary User](/automation/runbooks/runbook-references/org/devices/report-devices-without-primary-user.md)
  * [Report Stale Devices (Scheduled)](/automation/runbooks/runbook-references/org/devices/report-stale-devices_scheduled.md)
  * [Report Users With More Than 5-Devices](/automation/runbooks/runbook-references/org/devices/report-users-with-more-than-5-devices.md)
  * [Sync Device Serialnumbers To Entraid (Scheduled)](/automation/runbooks/runbook-references/org/devices/sync-device-serialnumbers-to-entraid_scheduled.md)
* [General](/automation/runbooks/runbook-references/org.md#org-general)
  * [Add Devices Of Users To Group (Scheduled)](/automation/runbooks/runbook-references/org/general/add-devices-of-users-to-group_scheduled.md)
  * [Add Management Partner](/automation/runbooks/runbook-references/org/general/add-management-partner.md)
  * [Add Microsoft Store App Logos](/automation/runbooks/runbook-references/org/general/add-microsoft-store-app-logos.md)
  * [Add Office365 Group](/automation/runbooks/runbook-references/org/general/add-office365-group.md)
  * [Add Or Remove Safelinks Exclusion](/automation/runbooks/runbook-references/org/general/add-or-remove-safelinks-exclusion.md)
  * [Add Or Remove Smartscreen Exclusion](/automation/runbooks/runbook-references/org/general/add-or-remove-smartscreen-exclusion.md)
  * [Add Or Remove Trusted Site](/automation/runbooks/runbook-references/org/general/add-or-remove-trusted-site.md)
  * [Add Primary Users Of Devices To Group (Scheduled)](/automation/runbooks/runbook-references/org/general/add-primary-users-of-devices-to-group_scheduled.md)
  * [Add Security Group](/automation/runbooks/runbook-references/org/general/add-security-group.md)
  * [Add User](/automation/runbooks/runbook-references/org/general/add-user.md)
  * [Add Viva Engange Community](/automation/runbooks/runbook-references/org/general/add-viva-engange-community.md)
  * [Assign Groups By Template (Scheduled)](/automation/runbooks/runbook-references/org/general/assign-groups-by-template_scheduled.md)
  * [Bulk Delete Devices From Autopilot](/automation/runbooks/runbook-references/org/general/bulk-delete-devices-from-autopilot.md)
  * [Bulk Retire Devices From Intune](/automation/runbooks/runbook-references/org/general/bulk-retire-devices-from-intune.md)
  * [Check Aad Sync Status (Scheduled)](/automation/runbooks/runbook-references/org/general/check-aad-sync-status_scheduled.md)
  * [Check Assignments Of Devices](/automation/runbooks/runbook-references/org/general/check-assignments-of-devices.md)
  * [Check Assignments Of Groups](/automation/runbooks/runbook-references/org/general/check-assignments-of-groups.md)
  * [Check Assignments Of Users](/automation/runbooks/runbook-references/org/general/check-assignments-of-users.md)
  * [Check Autopilot Serialnumbers](/automation/runbooks/runbook-references/org/general/check-autopilot-serialnumbers.md)
  * [Check Device Onboarding Exclusion (Scheduled)](/automation/runbooks/runbook-references/org/general/check-device-onboarding-exclusion_scheduled.md)
  * [Enrolled Devices Report (Scheduled)](/automation/runbooks/runbook-references/org/general/enrolled-devices-report_scheduled.md)
  * [Export All Autopilot Devices](/automation/runbooks/runbook-references/org/general/export-all-autopilot-devices.md)
  * [Export All Intune Devices](/automation/runbooks/runbook-references/org/general/export-all-intune-devices.md)
  * [Export Cloudpc Usage (Scheduled)](/automation/runbooks/runbook-references/org/general/export-cloudpc-usage_scheduled.md)
  * [Export Non Compliant Devices](/automation/runbooks/runbook-references/org/general/export-non-compliant-devices.md)
  * [Export Policy Report](/automation/runbooks/runbook-references/org/general/export-policy-report.md)
  * [Invite External Guest Users](/automation/runbooks/runbook-references/org/general/invite-external-guest-users.md)
  * [List All Administrative Template Policies](/automation/runbooks/runbook-references/org/general/list-all-administrative-template-policies.md)
  * [List Group License Assignment Errors](/automation/runbooks/runbook-references/org/general/list-group-license-assignment-errors.md)
  * [Office365 License Report](/automation/runbooks/runbook-references/org/general/office365-license-report.md)
  * [Report Apple MDM Cert Expiry (Scheduled)](/automation/runbooks/runbook-references/org/general/report-apple-mdm-cert-expiry_scheduled.md)
  * [Report License Assignment (Scheduled)](/automation/runbooks/runbook-references/org/general/report-license-assignment_scheduled.md)
  * [Report Pim Activations (Scheduled)](/automation/runbooks/runbook-references/org/general/report-pim-activations_scheduled.md)
  * [Sync All Devices](/automation/runbooks/runbook-references/org/general/sync-all-devices.md)
  * [Sync Apple Tokens](/automation/runbooks/runbook-references/org/general/sync-apple-tokens.md)
* [Mail](/automation/runbooks/runbook-references/org.md#org-mail)
  * [Add Distribution List](/automation/runbooks/runbook-references/org/mail/add-distribution-list.md)
  * [Add Equipment Mailbox](/automation/runbooks/runbook-references/org/mail/add-equipment-mailbox.md)
  * [Add Or Remove Public Folder](/automation/runbooks/runbook-references/org/mail/add-or-remove-public-folder.md)
  * [Add Or Remove Teams Mailcontact](/automation/runbooks/runbook-references/org/mail/add-or-remove-teams-mailcontact.md)
  * [Add Or Remove Tenant Allow Block List](/automation/runbooks/runbook-references/org/mail/add-or-remove-tenant-allow-block-list.md)
  * [Add Room Mailbox](/automation/runbooks/runbook-references/org/mail/add-room-mailbox.md)
  * [Add Shared Mailbox](/automation/runbooks/runbook-references/org/mail/add-shared-mailbox.md)
  * [Hide Mailboxes (Scheduled)](/automation/runbooks/runbook-references/org/mail/hide-mailboxes_scheduled.md)
  * [Set Booking Config](/automation/runbooks/runbook-references/org/mail/set-booking-config.md)
* [Phone](/automation/runbooks/runbook-references/org.md#org-phone)
  * [Get Teams Phone Number Assignment](/automation/runbooks/runbook-references/org/phone/get-teams-phone-number-assignment.md)
* [Security](/automation/runbooks/runbook-references/org.md#org-security)
  * [Add Defender Indicator](/automation/runbooks/runbook-references/org/security/add-defender-indicator.md)
  * [Backup Conditional Access Policies](/automation/runbooks/runbook-references/org/security/backup-conditional-access-policies.md)
  * [Find SMS Auth Phone Number](/automation/runbooks/runbook-references/org/security/find-sms-auth-phone-number.md)
  * [List Admin Users](/automation/runbooks/runbook-references/org/security/list-admin-users.md)
  * [List Expiring Role Assignments](/automation/runbooks/runbook-references/org/security/list-expiring-role-assignments.md)
  * [List Inactive Devices](/automation/runbooks/runbook-references/org/security/list-inactive-devices.md)
  * [List Inactive Users](/automation/runbooks/runbook-references/org/security/list-inactive-users.md)
  * [List Information Protection Labels](/automation/runbooks/runbook-references/org/security/list-information-protection-labels.md)
  * [List Pim Rolegroups Without Owners (Scheduled)](/automation/runbooks/runbook-references/org/security/list-pim-rolegroups-without-owners_scheduled.md)
  * [List Users By MFA Methods Count](/automation/runbooks/runbook-references/org/security/list-users-by-mfa-methods-count.md)
  * [List Vulnerable App Regs](/automation/runbooks/runbook-references/org/security/list-vulnerable-app-regs.md)
  * [Monitor Pending EPM Requests (Scheduled)](/automation/runbooks/runbook-references/org/security/monitor-pending-epm-requests_scheduled.md)
  * [Notify Changed CA Policies](/automation/runbooks/runbook-references/org/security/notify-changed-ca-policies.md)
  * [Report EPM Elevation Requests (Scheduled)](/automation/runbooks/runbook-references/org/security/report-epm-elevation-requests_scheduled.md)

#### User Runbooks

* [AVD](/automation/runbooks/runbook-references/user.md#user-avd)
  * [User Signout](/automation/runbooks/runbook-references/user/avd/user-signout.md)
* [General](/automation/runbooks/runbook-references/user.md#user-general)
  * [Assign Groups By Template](/automation/runbooks/runbook-references/user/general/assign-groups-by-template.md)
  * [Assign Or Unassign License](/automation/runbooks/runbook-references/user/general/assign-or-unassign-license.md)
  * [Assign Windows365](/automation/runbooks/runbook-references/user/general/assign-windows365.md)
  * [List Group Memberships](/automation/runbooks/runbook-references/user/general/list-group-memberships.md)
  * [List Group Ownerships](/automation/runbooks/runbook-references/user/general/list-group-ownerships.md)
  * [List Manager](/automation/runbooks/runbook-references/user/general/list-manager.md)
  * [Offboard User Permanently](/automation/runbooks/runbook-references/user/general/offboard-user-permanently.md)
  * [Offboard User Temporarily](/automation/runbooks/runbook-references/user/general/offboard-user-temporarily.md)
  * [Reprovision Windows365](/automation/runbooks/runbook-references/user/general/reprovision-windows365.md)
  * [Resize Windows365](/automation/runbooks/runbook-references/user/general/resize-windows365.md)
  * [Unassign Windows365](/automation/runbooks/runbook-references/user/general/unassign-windows365.md)
* [Mail](/automation/runbooks/runbook-references/user.md#user-mail)
  * [Add Or Remove Email Address](/automation/runbooks/runbook-references/user/mail/add-or-remove-email-address.md)
  * [Assign Owa Mailbox Policy](/automation/runbooks/runbook-references/user/mail/assign-owa-mailbox-policy.md)
  * [Convert To Shared Mailbox](/automation/runbooks/runbook-references/user/mail/convert-to-shared-mailbox.md)
  * [Delegate Full Access](/automation/runbooks/runbook-references/user/mail/delegate-full-access.md)
  * [Delegate Send As](/automation/runbooks/runbook-references/user/mail/delegate-send-as.md)
  * [Delegate Send On Behalf](/automation/runbooks/runbook-references/user/mail/delegate-send-on-behalf.md)
  * [Hide Or Unhide In Addressbook](/automation/runbooks/runbook-references/user/mail/hide-or-unhide-in-addressbook.md)
  * [List Mailbox Permissions](/automation/runbooks/runbook-references/user/mail/list-mailbox-permissions.md)
  * [List Room Mailbox Configuration](/automation/runbooks/runbook-references/user/mail/list-room-mailbox-configuration.md)
  * [Remove Mailbox](/automation/runbooks/runbook-references/user/mail/remove-mailbox.md)
  * [Set Out Of Office](/automation/runbooks/runbook-references/user/mail/set-out-of-office.md)
  * [Set Room Mailbox Configuration](/automation/runbooks/runbook-references/user/mail/set-room-mailbox-configuration.md)
* [Phone](/automation/runbooks/runbook-references/user.md#user-phone)
  * [Disable Teams Phone](/automation/runbooks/runbook-references/user/phone/disable-teams-phone.md)
  * [Get Teams User Info](/automation/runbooks/runbook-references/user/phone/get-teams-user-info.md)
  * [Grant Teams User Policies](/automation/runbooks/runbook-references/user/phone/grant-teams-user-policies.md)
  * [Set Teams Permanent Call Forwarding](/automation/runbooks/runbook-references/user/phone/set-teams-permanent-call-forwarding.md)
  * [Set Teams Phone](/automation/runbooks/runbook-references/user/phone/set-teams-phone.md)
* [Security](/automation/runbooks/runbook-references/user.md#user-security)
  * [Confirm Or Dismiss Risky User](/automation/runbooks/runbook-references/user/security/confirm-or-dismiss-risky-user.md)
  * [Create Temporary Access Pass](/automation/runbooks/runbook-references/user/security/create-temporary-access-pass.md)
  * [Enable Or Disable Password Expiration](/automation/runbooks/runbook-references/user/security/enable-or-disable-password-expiration.md)
  * [Reset Mfa](/automation/runbooks/runbook-references/user/security/reset-mfa.md)
  * [Reset Password](/automation/runbooks/runbook-references/user/security/reset-password.md)
  * [Revoke Or Restore Access](/automation/runbooks/runbook-references/user/security/revoke-or-restore-access.md)
  * [Set Or Remove Mobile Phone Mfa](/automation/runbooks/runbook-references/user/security/set-or-remove-mobile-phone-mfa.md)
* [Userinfo](/automation/runbooks/runbook-references/user.md#user-userinfo)
  * [Rename User](/automation/runbooks/runbook-references/user/userinfo/rename-user.md)
  * [Set Photo](/automation/runbooks/runbook-references/user/userinfo/set-photo.md)
  * [Update User](/automation/runbooks/runbook-references/user/userinfo/update-user.md)


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.realmjoin.com/automation/runbooks/runbook-references.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
