> 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/security/sync-mfa-secure-users-to-group_scheduled.md).
# Sync Mfa Secure Users To Group Scheduled
{% hint style="info" %}
This is a scheduled runbook. It is designed to run on a recurring schedule rather than being triggered for a single object. See [Scheduling](/automation/runbooks/scheduling.md) for details on how to configure runbook schedules.
{% endhint %}
### Description
This runbook synchronizes an Entra ID group with all member users that have at least one "secure" authentication method registered, based on the Entra ID authentication methods registration report. Which method groups count as secure is configurable via toggles (Passkeys/FIDO2, platform credentials, Microsoft Authenticator app, software OTP, hardware OTP, certificate-based authentication). Users that no longer have a secure method registered are removed from the group. An optional strict mode ("SecureOnly") additionally disqualifies users that have any unsecure method (phone, email, security questions) registered alongside their secure method. Admin users (holders of an Entra ID directory role, active or PIM-eligible, including members of role-assignable groups) are excluded by default ("ExcludeAdmins") - useful when the target group drives SSPR, where admins would otherwise be forced to register a second factor. An optional exclusion group keeps accounts like break glass or service accounts permanently out of the target group; individual users can additionally be excluded directly via a multi-user picker ("ExcludeUserIds"). Excluded users are never added and are removed if they are already members. Guest users and non-user group members are never touched.
Optionally, a detailed report can be sent via email and/or uploaded to an Azure Storage Account (returning time-limited download links). The report contains CSV files and a formatted Excel workbook with an info cover sheet (chosen parameters and result counts), the performed changes and a per-user evaluation of all member users. Report files are only generated when email or download link is enabled.
### How it works
The runbook reads the Entra ID [authentication methods registration report](https://learn.microsoft.com/en-us/graph/api/authenticationmethodsroot-list-userregistrationdetails) (`userRegistrationDetails`) and mirrors the target group against all **member users** that qualify:
* A user qualifies when at least one of their registered methods is in the configured **secure** set.
* In **strict mode** (`SecureOnly`), a user additionally must not have any method from the **unsecure** set registered — a passkey user who also keeps an SMS factor does not qualify.
* Qualifying users that are not yet group members are added; members that no longer qualify are removed (mirror sync).
* Guest users are never added or removed. Non-user group members (devices, service principals, nested groups) are never touched.
The target group should be managed exclusively by this runbook.
### Secure method groups
Each toggle controls which `methodsRegistered` values count as secure:
| Toggle | Default | Covered values |
| -------------------------------- | ------- | ------------------------------------------------------------------------------------ |
| Passkeys / FIDO2 security keys | on | `fido2SecurityKey`, `passKeyDeviceBound`, `passKeyDeviceBoundAuthenticator` |
| Platform credentials | on | `windowsHelloForBusiness`, `passKeyDeviceBoundWindowsHello`, `macOsSecureEnclaveKey` |
| Microsoft Authenticator app | on | `microsoftAuthenticatorPush`, `microsoftAuthenticatorPasswordless` |
| Software OTP | off | `softwareOneTimePasscode` |
| Hardware OTP | off | `hardwareOneTimePasscode` |
| Certificate-based authentication | on | `certificateBasedAuthentication` |
### Strict mode (SecureOnly)
With strict mode enabled, users with any of the following built-in unsecure methods never qualify:
`mobilePhone`, `alternateMobilePhone`, `officePhone`, `email`, `securityQuestion`
If a method ends up in both the secure and the unsecure set (only possible via the override parameters), unsecure wins — such users never qualify in strict mode. The runbook warns about this at startup.
### Exclusions
Excluded users never qualify regardless of their registered methods: they are never added to the target group and are removed if they are already members. The per-user report shows the reason in the `ExclusionReason` column.
#### Exclude admin users (`ExcludeAdmins`, on by default)
Users holding an Entra ID directory role are excluded. This covers:
* **Active role assignments** (`roleManagement/directory/roleAssignments`)
* **PIM-eligible assignments** (`roleManagement/directory/roleEligibilitySchedules`, requires Entra ID P2 — without P2 the runbook falls back to active assignments and logs a warning)
* **Role-assignable groups**: groups holding a role are expanded to their transitive user members
Background: when the target group drives **SSPR** and the SSPR administrator policy is disabled, admins in the group would still be forced to register a second factor once two SSPR methods are required. Keeping admins out of the group avoids this.
This option requires the additional Graph permission `RoleManagement.Read.Directory` for the managed identity.
#### Exclusion group (`ExcludeGroupId`, optional)
Transitive user members of the configured group are excluded — intended for accounts that must never be managed by this sync, such as **break glass accounts** or **service accounts**. Nested groups are honored. The exclusion group must not be the target group itself.
#### Individually excluded users (`ExcludeUserIds`, optional)
Individual users can be excluded directly via the multi-user picker — for one-off exclusions where a dedicated exclusion group is not worth maintaining. The list accepts user **object IDs** and **user principal names** (UPNs). Unresolvable entries (e.g. a deleted account) log a warning and are ignored, so a stale entry never breaks a scheduled sync.
#### Maintaining exclusions via Runbook Customization (without the pickers)
Both exclusion parameters can be pre-set centrally via [JSON-based Runbook Customization](https://docs.realmjoin.com/automation/runbooks/runbook-customization#json-based-customizing) (RealmJoin portal: **Settings** → **Runbook Customizations**) — useful when the exclusions are fixed for the tenant and should not be picked manually each time the runbook is started or scheduled:
```json
{
"Runbooks": {
"rjgit-org_security_sync-mfa-secure-users-to-group_scheduled": {
"Parameters": {
"ExcludeGroupId": {
"DefaultValue": "00000000-0000-0000-0000-000000000000",
"Hide": true
},
"ExcludeUserIds": {
"DefaultValue": [
"11111111-1111-1111-1111-111111111111",
"breakglass@contoso.com"
],
"Hide": true
}
}
}
}
}
```
* **ExcludeGroupId** takes a single group **object ID** (GUID) as a plain string — copy it from the group's overview page in the Entra admin center or the RealmJoin portal.
* **ExcludeUserIds** takes a JSON **array of strings**; each entry can be a user **object ID** or a **UPN**. Entries are trimmed and deduplicated; the runbook resolves them at startup.
* **Recommended:** when the exclusions are maintained via Runbook Customization, also set `"Hide": true` on the parameter (as in the example above). This removes it from the start form entirely, so the centrally configured exclusions cannot be overridden in the UI when starting or scheduling the runbook. Without `Hide`, the configured values only appear pre-filled and can still be changed there.
### Method classification reference
Use the exact Graph values from this table when building the comma-separated override strings:
| `methodsRegistered` value | Friendly name | Classification | Covered by toggle (default) |
| ------------------------------------ | ---------------------------------------------------- | -------------- | ------------------------------------- |
| `fido2SecurityKey` | FIDO2 security key | Secure | Passkeys / FIDO2 (on) |
| `passKeyDeviceBound` | Passkey (device-bound) | Secure | Passkeys / FIDO2 (on) |
| `passKeyDeviceBoundAuthenticator` | Passkey in Microsoft Authenticator | Secure | Passkeys / FIDO2 (on) |
| `windowsHelloForBusiness` | Windows Hello for Business | Secure | Platform credentials (on) |
| `passKeyDeviceBoundWindowsHello` | Passkey in Windows Hello | Secure | Platform credentials (on) |
| `macOsSecureEnclaveKey` | Platform Credential for macOS | Secure | Platform credentials (on) |
| `microsoftAuthenticatorPush` | Microsoft Authenticator (push notification) | Secure | Microsoft Authenticator app (on) |
| `microsoftAuthenticatorPasswordless` | Microsoft Authenticator (passwordless phone sign-in) | Secure | Microsoft Authenticator app (on) |
| `softwareOneTimePasscode` | Software OATH token (TOTP app) | Secure | Software OTP (off) |
| `hardwareOneTimePasscode` | Hardware OATH token | Secure | Hardware OTP (off) |
| `certificateBasedAuthentication` | Certificate-based authentication | Secure | Certificate-based authentication (on) |
| `mobilePhone` | Phone (SMS / voice call) | Unsecure | built-in unsecure list |
| `alternateMobilePhone` | Alternate phone (voice call) | Unsecure | built-in unsecure list |
| `officePhone` | Office phone (voice call) | Unsecure | built-in unsecure list |
| `email` | Email (SSPR only) | Unsecure | built-in unsecure list |
| `securityQuestion` | Security questions (SSPR only) | Unsecure | built-in unsecure list |
| `temporaryAccessPass` | Temporary Access Pass | Neutral | never qualifies, never disqualifies |
Unknown or future Graph values are treated as neutral unless explicitly listed in an override parameter.
### Override parameters
Both override parameters are hidden by default and intended for RealmJoin runbook customization:
* **SecureMethodsOverride** — comma-separated list of `methodsRegistered` values that defines the secure set. When set, **all** method group toggles are ignored. Example: `fido2SecurityKey,passKeyDeviceBound,passKeyDeviceBoundAuthenticator,windowsHelloForBusiness`
* **UnsecureMethodsOverride** — comma-separated list that replaces the built-in unsecure list. Only evaluated in strict mode. Example: `mobilePhone,alternateMobilePhone,officePhone,email,securityQuestion,softwareOneTimePasscode`
Unknown values produce a warning but are still evaluated, so future Graph values can be used before this documentation catches up.
### Email report and download links
Optionally, a detailed report can be delivered - especially useful for reviewing the very first run (ideally combined with the dry run mode):
* **Send report via email** (`SendEmail`, off by default): sends the report to the configured recipient(s). The recipient field only appears when email is enabled. Requires the `RJReport.EmailSender` tenant setting (see the [RealmJoin Report Settings documentation](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings)).
* **Create file download links** (`CreateDownloadLink`, off by default): uploads the report files to an Azure Storage Account and returns time-limited download links (uses the `RJReport.StorageAccount.*` tenant settings).
Report files are only generated when at least one of the two options is enabled. The report consists of:
* **mfa-secure-users-group-sync-changes.csv** - all performed (or, in dry run, pending) changes with per-user method details
* **mfa-secure-users-group-sync-all-users.csv** - the evaluation of every member user: registered methods, secure/unsecure classification, qualification, exclusion reason and group membership
* **mfa-secure-users-group-sync-report.xlsx** - the same data as a formatted Excel workbook: an "Info" cover sheet with the chosen parameters and result counts, a "Changes" worksheet (added users highlighted in green, removed in red) and an "All Users" worksheet
In large tenants the raw CSV files can exceed the email attachment size limit (Graph rejects mails at roughly 4 MB total). When the CSV files exceed a 2.5 MB budget, the email is sent with only the Excel workbook attached (which contains the complete data in compressed form) and a note explaining the omission; a failed full-size send is also retried automatically with the workbook only. The download link upload always includes all files regardless of size.
#### Email branding
The report email honors the optional `RJReport.Branding.*` tenant settings: a custom header image, a custom footer image (public HTTPS URLs, PNG/JPEG/GIF, max. 200 KB each), a custom footer link, and custom accent and text colors (6-digit hex values, e.g. `#0052cc`). When these settings are not configured, the default RealmJoin graphics and colors are used. A branding image that cannot be downloaded or validated, or a color value that is not a valid hex color, never prevents the report email - the corresponding default is used instead.
See the [RealmJoin Report Settings documentation](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings) for setup details.
### Notes and limitations
* The registration report requires an **Entra ID P1 or P2** license.
* PIM-eligible role assignments (admin exclusion) require an **Entra ID P2** license — without it, only active role assignments are excluded.
* The report does not include **disabled** or soft-deleted users — such accounts are removed from the group on the next run.
* Report data can lag behind recent registration changes; a newly registered method may take one sync cycle to be reflected.
* The runbook processes large tenants (20k+ users) via paged report reads and batched group writes with automatic throttling retries.
### Scheduling
The sync is idempotent — a single recurring schedule (e.g. daily) keeps the group up to date, and reruns after partial failures self-heal. Recommendation: run once with **Dry run (WhatIf)** enabled and review the job output before scheduling the runbook in live mode.
### Location
Organization → Security → Sync MFA Secure Users To Group (Scheduled)
**Full Runbook name**
rjgit-org\_security\_sync-MFA-secure-users-to-group\_scheduled
### Details
| Property | Value |
| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
| Version | 1.5.0 |
| Required modules | RealmJoin.RunbookHelper (>= 0.8.9)
Microsoft.Graph.Authentication (>= 2.39.0)
Az.Accounts (>= 5.5.2)
|
| Schedulable | yes |
### Permissions
#### Application permissions
* **Type**: Microsoft Graph
* AuditLog.Read.All
* *Reads userRegistrationDetails to evaluate each user's registered MFA methods*
* Group.Read.All
* *Reads the target and exclusion groups and their transitive user members*
* RoleManagement.Read.Directory
* *Reads role assignments and eligibility schedules to exclude admin users when ExcludeAdmins is enabled*
* GroupMember.ReadWrite.All
* *Adds and removes users in the target group via batched /groups/{id}/members/$ref calls*
* User.Read.All
* *Resolves admin-role principals and ExcludeUserIds entries to user objects*
* Organization.Read.All
* *Reads /organization for the tenant name on the report cover sheet and in the email*
* Mail.Send *(optional — feature: Email report)*
* *Sends the report email via Send-RjReportEmail when email reporting is enabled*
### Parameters
#### TargetGroupId
The Entra ID group to synchronize into. Members of this group will be managed exclusively by this runbook.
| Property | Value |
| ------------------- | ------------------------------------------------------ |
| Required | true |
| Default Value | |
| Type | String |
| Portal display name | Target Group (sync users with secure MFA methods into) |
#### IncludePasskeys
Count passkeys and FIDO2 security keys as secure (fido2SecurityKey, passKeyDeviceBound, passKeyDeviceBoundAuthenticator).
| Property | Value |
| ------------------- | ---------------------------------------------- |
| Required | false |
| Default Value | True |
| Type | Boolean |
| Portal display name | Passkeys / FIDO2 security keys count as secure |
#### IncludePlatformCredentials
Count platform credentials as secure (windowsHelloForBusiness, passKeyDeviceBoundWindowsHello, macOsSecureEnclaveKey).
| Property | Value |
| ------------------- | ---------------------------------------------------------------------------------------- |
| Required | false |
| Default Value | True |
| Type | Boolean |
| Portal display name | Platform credentials (Windows Hello for Business / macOS Secure Enclave) count as secure |
#### IncludeMicrosoftAuthenticator
Count the Microsoft Authenticator app as secure (microsoftAuthenticatorPush, microsoftAuthenticatorPasswordless).
| Property | Value |
| ------------------- | -------------------------------------------------------------------------- |
| Required | false |
| Default Value | True |
| Type | Boolean |
| Portal display name | Microsoft Authenticator app (push / passwordless sign-in) counts as secure |
#### IncludeSoftwareOtp
Count software OTP / authenticator TOTP apps as secure (softwareOneTimePasscode).
| Property | Value |
| ------------------- | ------------------------------------------------------- |
| Required | false |
| Default Value | False |
| Type | Boolean |
| Portal display name | Software OTP (authenticator TOTP apps) counts as secure |
#### IncludeHardwareOtp
Count hardware OTP tokens as secure (hardwareOneTimePasscode).
| Property | Value |
| ------------------- | ----------------------------------- |
| Required | false |
| Default Value | False |
| Type | Boolean |
| Portal display name | Hardware OTP tokens count as secure |
#### IncludeCertificateBasedAuth
Count certificate-based authentication as secure (certificateBasedAuthentication).
| Property | Value |
| ------------------- | ------------------------------------------------- |
| Required | false |
| Default Value | True |
| Type | Boolean |
| Portal display name | Certificate-based authentication counts as secure |
#### SecureOnly
Strict mode: users that have any unsecure method registered (mobilePhone, alternateMobilePhone, officePhone, email, securityQuestion) never qualify, even if they also have a secure method. They are removed from the group if already a member.
| Property | Value |
| ------------------- | -------------------------------------------------------------------------------------------- |
| Required | false |
| Default Value | False |
| Type | Boolean |
| Portal display name | Strict mode: users with any unsecure method (phone, email, security questions) never qualify |
#### SecureMethodsOverride
Optional. Comma-separated list of methodsRegistered values that define the secure set. When set, ALL method group toggles are ignored. See the runbook documentation for all known values.
| Property | Value |
| ------------------- | -------------------------------------------------------------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Portal display name | Expert: custom secure methods list (comma-separated, replaces ALL toggles above) |
| Hidden in portal | yes (preset via runbook customization) |
#### UnsecureMethodsOverride
Optional. Comma-separated list of methodsRegistered values that replace the built-in unsecure list. Only evaluated in strict mode (SecureOnly).
| Property | Value |
| ------------------- | ------------------------------------------------------------------------------ |
| Required | false |
| Default Value | |
| Type | String |
| Portal display name | Expert: custom unsecure methods list (comma-separated, replaces built-in list) |
| Hidden in portal | yes (preset via runbook customization) |
#### ExcludeAdmins
Exclude admin users: users holding an Entra ID directory role (active or PIM-eligible, including members of role-assignable groups) never qualify and are removed from the group if they are already members. Enabled by default - when the target group drives SSPR, admins would otherwise be forced to register a second factor.
| Property | Value |
| ------------------- | ---------------------------------------------------------------- |
| Required | false |
| Default Value | True |
| Type | Boolean |
| Portal display name | Exclude admin users (directory role holders, incl. PIM-eligible) |
#### ExcludeGroupId
Optional exclusion group: transitive user members of this group (e.g. break glass or service accounts) never qualify and are removed from the group if they are already members.
| Property | Value |
| ------------------- | ---------------------------------------------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Portal display name | Exclusion group (members are never synced into the target group) |
#### ExcludeUserIds
Optional list of individually excluded users: these users never qualify and are removed from the group if they are already members. Accepts user object IDs and user principal names; unresolvable entries are ignored with a warning.
| Property | Value |
| ------------------- | --------------------------------------------------- |
| Required | false |
| Default Value | @() |
| Type | String\[] |
| Portal display name | Excluded users (never synced into the target group) |
#### WhatIfMode
Dry run: log which users would be added or removed without changing the group.
| Property | Value |
| ------------------- | ------------------------------ |
| Required | false |
| Default Value | False |
| Type | Boolean |
| Portal display name | Dry run (log only, no changes) |
#### SendEmail
If enabled, the report is sent via email with CSV and Excel (xlsx) attachments. Disabled by default.
| Property | Value |
| ------------------- | ---------------------- |
| Required | false |
| Default Value | False |
| Type | Boolean |
| Portal display name | Send report via email? |
**Portal options**
| Portal option | Value |
| ------------------------------- | ----- |
| Yes - send the report via email | |
| No - do not send an email | |
#### EmailTo
Recipient email address(es) for the report. Can be a single address or multiple comma-separated addresses (string). Only used when SendEmail is enabled.
| Property | Value |
| ------------------- | --------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Portal display name | Recipient Email Address(es) |
#### EmailFrom
The sender email address. Sourced from the RJReport tenant settings.
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Hidden in portal | yes (preset via runbook customization) |
#### BrandingHeaderImageUrl
Optional public HTTPS URL of a custom header image (PNG/JPEG/GIF, max. 200 KB) for the report email. Sourced from the RJReport.Branding.HeaderImageUrl tenant setting. When empty, the default RealmJoin header graphic is used.
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Hidden in portal | yes (preset via runbook customization) |
#### BrandingFooterImageUrl
Optional public HTTPS URL of a custom footer image (PNG/JPEG/GIF, max. 200 KB) for the report email. Sourced from the RJReport.Branding.FooterImageUrl tenant setting. When empty, the default RealmJoin footer graphic is used.
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Hidden in portal | yes (preset via runbook customization) |
#### BrandingFooterLink
Optional URL the footer image links to. Sourced from the RJReport.Branding.FooterLink tenant setting. When empty, the default link () is used.
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Hidden in portal | yes (preset via runbook customization) |
#### BrandingAccentColor
Optional accent color override (6-digit hex, e.g. '#0052cc') for the report email template. Sourced from the RJReport.Branding.AccentColor tenant setting. When empty or invalid, the default RealmJoin accent color is used.
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Hidden in portal | yes (preset via runbook customization) |
#### BrandingTextColor
Optional text color override (6-digit hex) for the report email template. Sourced from the RJReport.Branding.TextColor tenant setting. When empty or invalid, the default RealmJoin text color is used.
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Hidden in portal | yes (preset via runbook customization) |
#### ReportFileFormat
Controls which report file formats are generated and delivered: "CSV only", "CSV & XLSX" (default) or "XLSX only".
| Property | Value |
| ------------------- | -------------------------------------- |
| Required | false |
| Default Value | CSV & XLSX |
| Type | String |
| Portal display name | Report file format |
| Hidden in portal | yes (preset via runbook customization) |
**Portal options**
| Portal option | Value |
| ------------- | ----- |
| CSV & XLSX | |
| CSV only | |
| XLSX only | |
#### CreateDownloadLink
If enabled, the report files are uploaded to an Azure Storage Account and time-limited download links are returned. Disabled by default.
| Property | Value |
| ------------------- | ------------------------------------------------------ |
| Required | false |
| Default Value | False |
| Type | Boolean |
| Portal display name | Create file download links (upload report to storage)? |
**Portal options**
| Portal option | Value |
| ------------------------------------------------- | ----- |
| Yes - upload the report and return download links | |
| No - do not create download links | |
#### ContainerName
Storage container name used for the upload. Configured per runbook (not a global RJReport setting).
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | false |
| Default Value | sync-mfa-secure-users-to-group |
| Type | String |
| Hidden in portal | yes (preset via runbook customization) |
#### ResourceGroupName
Resource group that contains the storage account. Sourced from the RJReport tenant settings.
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Hidden in portal | yes (preset via runbook customization) |
#### StorageAccountName
Storage account name used for the upload. Sourced from the RJReport tenant settings.
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | false |
| Default Value | |
| Type | String |
| Hidden in portal | yes (preset via runbook customization) |
#### LinkExpiryDays
Number of days until the generated download link expires. Sourced from the RJReport tenant settings.
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | false |
| Default Value | 6 |
| Type | Int32 |
| Hidden in portal | yes (preset via runbook customization) |
[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 dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.realmjoin.com/automation/runbooks/runbook-references/org/security/sync-mfa-secure-users-to-group_scheduled.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
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.