> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/dokumentation/automation/connectors/microsoft-entra-id.md).

# Microsoft Entra ID

Microsoft Entra ID connector: manage users, groups, licenses, devices and app registrations from flows – onboarding, offboarding and directory checks.

**Path:** "Automation" → "Workflows" → flow designer → module **"Microsoft Entra ID"**

The **Microsoft Entra ID connector** connects equipme in [workflows](https://hub.equipme.io/dokumentation/automation/workflows.md) with your Microsoft directory. Use it to create user accounts automatically during onboarding, assign groups and licenses, block accounts during offboarding and check your directory regularly for issues – such as inactive accounts, unused licenses or expiring app secrets.

## What for?

* **Onboarding:** new employee in equipme → create the user account in Entra ID, set the manager, assign groups and licenses, create a Temporary Access Pass for the first sign-in.
* **Offboarding:** employee changes to the status "offboarding" → block the account, end all sessions, remove licenses, remove from groups.
* **Keep master data in sync:** copy department, job title or location from equipme to the Entra ID profile.
* **License costs under control:** check license stock and unused licenses of blocked accounts regularly and report them by email.
* **Security and governance:** detect expiring client secrets, groups without owners, admins without MFA or stale devices.

## Prerequisites

* The enabled [automation module](https://hub.equipme.io/dokumentation/automation.md)
* A Microsoft 365 or Entra ID tenant
* A Microsoft account in this tenant with suitable admin roles – depending on the action, e.g. "User Administrator", "Groups Administrator", "License Administrator", "Authentication Administrator", "Application Administrator" or "Privileged Role Administrator"
* Consent to the requested permissions in the tenant (most permissions require **admin consent**)
* For examples using equipme data, a connection of the [equipme connector](https://hub.equipme.io/dokumentation/automation/connectors/equipme.md) as well

## Setting up the connection

1. In the flow designer, drag a component of the "Microsoft Entra ID" module onto the canvas (e.g. *GetUser*).
2. Click **Connect account**.
3. Sign in with the tenant account in the Microsoft sign-in window and accept the requested permissions.
4. The connection appears with the name of the Microsoft account under **"Accounts"** and is available to all components.

{% hint style="info" %}
The modules "Microsoft Entra ID", "Microsoft Intune" and "Microsoft Dynamics 365 Business Central" use the same Microsoft sign-in. All actions run with the permissions of the signed-in account. Ideally, use a dedicated service account for automation so that changes can be clearly attributed in the Entra ID audit log.
{% endhint %}

## Basic concepts

* **User ID / Group ID / Device ID / Application ID:** most actions expect the object ID from Entra ID. For users, many actions also accept the user principal name (UPN, e.g. `max.muster@company.com`). You pass IDs from previous steps, for example from the result of *AddUser* or *ListUsers*.
* **List actions and "Output Type":** all *List…* actions read all entries and offer **Output Type** ("All items at once", "One item at a time", "First item only", "Store to CSV file") – just like the [equipme connector](https://hub.equipme.io/dokumentation/automation/connectors/equipme.md#list-actions-and-output-type).
* **OData Filter:** *ListUsers*, *ListGroups* and *ListDevices* can be narrowed down with a filter expression, e.g. `accountEnabled eq false` or `startswith(displayName,'Test')`.
* **Monitor components:** the *Monitor…* actions check the directory and have two outputs: **findings** (there are hits, with a list and a readable summary) and **ok** (everything is fine). So you do not need an extra filter in the flow.

## Triggers

| Component          | Fires when …                                                                            | Settings                                                                                                                                                                                                       |
| ------------------ | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| NewUser            | a new user is created (regular polling)                                                 | After                                                                                                                                                                                                          |
| NewGroupMember     | a member is added to a group (notification from Microsoft)                              | Group                                                                                                                                                                                                          |
| RemovedGroupMember | a member is removed from a group (notification from Microsoft)                          | Group                                                                                                                                                                                                          |
| SecretExpiring     | a client secret or certificate of an app registration is about to expire or has expired | Check Interval ("Every Minute", "Hourly", "Daily", "Weekly"; default "Daily"), Warning Threshold (Days, default 60), Escalation Threshold (Days, default 30), Include Certificates, Include Service Principals |

*SecretExpiring* has three outputs: **warning** (below the warning threshold), **escalation** (below the escalation threshold) and **overdue** (expired). Each credential is reported only once per stage.

## Actions

### Users

| Component                       | Purpose                                                 | Important options                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| AddUser                         | Create a user                                           | Required: User principal name, Mail nickname, Display name, Force change password, Account enabled. Optional: Password (empty = random password, length via "Password length"), Given name, Surname, Job title, Company name, Department, Employee ID, Employee type, Employee hire date, Employee leave date time, Office location, address, Business phone, Mobile phone, Mail, Other mails, Usage Location (country code, required for licenses), Manager ID, Age group, User type ("Member", "Guest") |
| UpdateUser                      | Change a user                                           | User ID; the same fields as *AddUser*; turning "Account enabled" off blocks sign-in                                                                                                                                                                                                                                                                                                                                                                                                                       |
| GetUser                         | Read a user                                             | User ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ListUsers                       | List users                                              | OData Filter, After, Output Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| DeleteUser                      | Delete a user (kept in the recycle bin for 30 days)     | User ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| GetUserManager / SetUserManager | Read or set the manager                                 | User ID, Manager ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ResetUserPassword               | Reset the password                                      | User ID, Password (empty = random, default length 10), Force Change Password Next Sign In                                                                                                                                                                                                                                                                                                                                                                                                                 |
| RevokeUserSessions              | End all sign-in sessions – important during offboarding | User ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| InviteGuest                     | Invite an external person as a guest                    | Email Address, Display Name, Redirect URL, Send Invitation Message, Message Body; returns the redemption link                                                                                                                                                                                                                                                                                                                                                                                             |
| ListUserDevices                 | List the devices of a user                              | User ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

### Groups

| Component                                          | Purpose                                                    | Important options                                                                                                                                                                                                                                |
| -------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| AddGroup                                           | Create a group                                             | Required: Display name, Mail enabled, Mail nickname, Security enabled. Optional: Description, Group types, Visibility ("Private", "Public", "Hidden Membership"), Membership Rule (dynamic group, e.g. `user.department -eq "Sales"`), Owner IDs |
| UpdateGroup                                        | Change a group                                             | Group ID, Display name, Description, Mail nickname, Unique name                                                                                                                                                                                  |
| GetGroup / ListGroups / DeleteGroup                | Read, list, delete a group                                 | Group ID; *ListGroups* with OData Filter, After, Output Type                                                                                                                                                                                     |
| AddGroupMembers                                    | Add members                                                | Group ID, Users (comma-separated list of user IDs)                                                                                                                                                                                               |
| RemoveGroupMember                                  | Remove a member                                            | Group, Member (selection list or ID)                                                                                                                                                                                                             |
| ListGroupMembers                                   | List members                                               | Group ID, Output Type                                                                                                                                                                                                                            |
| CheckGroupMembership                               | Check whether a user is a member (including nested groups) | User ID, Group IDs (up to 20)                                                                                                                                                                                                                    |
| ListGroupOwners / AddGroupOwner / RemoveGroupOwner | Manage owners                                              | Group ID, User ID                                                                                                                                                                                                                                |

### Licenses and roles

| Component                                 | Purpose                                                         | Important options                |
| ----------------------------------------- | --------------------------------------------------------------- | -------------------------------- |
| ListLicenses                              | Licenses (SKUs) of the tenant with consumed and available units | Output Type                      |
| AssignLicense                             | Assign licenses (the user needs a usage location)               | User ID, SKU IDs, Disabled Plans |
| RemoveLicense                             | Remove licenses                                                 | User ID, SKU IDs                 |
| ListDirectoryRoles                        | List activated directory roles                                  | Output Type                      |
| AssignDirectoryRole / RemoveDirectoryRole | Assign or remove a directory role                               | Role Template ID, User ID        |

### Authentication

| Component                  | Purpose                                                | Important options                                                     |
| -------------------------- | ------------------------------------------------------ | --------------------------------------------------------------------- |
| CreateTemporaryAccessPass  | Temporary Access Pass for a passwordless first sign-in | User ID, Lifetime (Minutes, default 60), Usable Once, Start Date Time |
| ListAuthenticationMethods  | Registered MFA methods of a user                       | User ID, Output Type                                                  |
| DeleteAuthenticationMethod | Remove an MFA method (e.g. for a lost smartphone)      | User ID, Method Type, Method ID                                       |

### Devices

| Component               | Purpose                                      | Important options                                                                                                  |
| ----------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| AddDevice               | Create a device                              | Account enabled, Display name, Operating system, Operating system version, Profile type, Extension attributes 1–15 |
| UpdateDevice            | Change a device                              | Device ID and the same fields as *AddDevice*                                                                       |
| GetDevice / ListDevices | Read or list devices                         | *ListDevices* with OData Filter, Stale For (Days), Output Type                                                     |
| DisableDevice           | Disable a device so it can no longer sign in | Device ID                                                                                                          |
| DeleteDevice            | Delete a device                              | Device ID                                                                                                          |

### App registrations

| Component                                                 | Purpose                                                  | Important options                                                                                  |
| --------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| ListApplications / GetApplication                         | List or read app registrations                           | Display Name Filter; Application ID or App ID (Client ID)                                          |
| CreateApplication / UpdateApplication / DeleteApplication | Create, change, delete an app registration               | Display Name, Sign In Audience, Notes, Tags, Identifier URIs, Redirect URIs                        |
| AddApplicationOwner                                       | Add an owner                                             | Application ID, User ID                                                                            |
| AddApplicationSecret                                      | Create a client secret (the value is returned only once) | Application ID, Secret Name, Valid For (Months, default 24) or End Date Time                       |
| RemoveApplicationSecret                                   | Remove a client secret                                   | Application ID, Key ID                                                                             |
| AddApplicationCertificate                                 | Upload a public certificate                              | Application ID, Certificate, Certificate Name                                                      |
| ListExpiringSecrets                                       | List secrets and certificates with remaining lifetime    | Max Remaining Days, Include Certificates, Include Expired, Include Service Principals, Output Type |

### Recycle bin

| Component          | Purpose                                                       | Important options                                          |
| ------------------ | ------------------------------------------------------------- | ---------------------------------------------------------- |
| ListDeletedItems   | Deleted users, groups or app registrations (kept for 30 days) | Type ("Users", "Groups", "App Registrations"), Output Type |
| RestoreDeletedItem | Restore a deleted object                                      | Object ID                                                  |

### Checks (Monitor)

All monitor actions have the outputs **findings** and **ok** and are well suited to a schedule (Scheduler).

| Component                 | Checks …                                                                                | Settings (default)                                                                         |
| ------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| MonitorInactiveUsers      | Accounts without a sign-in for X days or without any sign-in                            | Inactive For (Days) (90), Include Guests, Include Never Signed In                          |
| MonitorStaleGuests        | Guests with an unredeemed invitation or inactive for a long time                        | Pending Invitation For (Days) (30), Inactive For (Days) (90)                               |
| MonitorUnusedLicenses     | Blocked accounts that still have licenses                                               | –                                                                                          |
| MonitorLicenseStock       | Licenses with too few available units                                                   | Minimum Available Units (5), SKU Filter                                                    |
| MonitorGroupsWithoutOwner | Groups without an owner                                                                 | Security Groups Only                                                                       |
| MonitorExpiringGroups     | Microsoft 365 groups (including Teams) about to expire                                  | Expires Within (Days) (30)                                                                 |
| MonitorDeletedItemsPurge  | Deleted objects shortly before final deletion                                           | Warn Before Purge (Days) (7)                                                               |
| MonitorAdminRoles         | Too many Global Administrators, blocked accounts with roles, guests with admin roles    | Max Global Administrators (5)                                                              |
| MonitorMfaRegistration    | Users without a registered MFA method                                                   | Admins Only                                                                                |
| MonitorSyncHealth         | Whether synchronization from the on-premises directory (Entra Connect) is still running | Max Sync Age (Hours) (2)                                                                   |
| MonitorStaleDevices       | Devices without a sign-in for X days                                                    | Stale For (Days) (90), Include Disabled                                                    |
| MonitorNewApplications    | Newly created app registrations                                                         | Created Within (Days) (7)                                                                  |
| MonitorExpiringSecrets    | Secrets and certificates about to expire                                                | Max Remaining Days (30), Include Certificates, Include Service Principals, Include Expired |

## Examples

### Onboarding: create an account for new employees

1. **Equipme › New Employee** – trigger, optionally filtered by location.
2. **Microsoft Entra ID › AddUser** – user principal name and mail from the email address, Given name, Surname, Display name, Department, Job title, Employee ID (personnel number), Employee hire date (start date), Usage Location `DE`, Force change password on.
3. **Microsoft Entra ID › AddGroupMembers** – add the new account to the location's standard groups.
4. **Microsoft Entra ID › AssignLicense** – e.g. assign the Microsoft 365 license.
5. **Microsoft Entra ID › CreateTemporaryAccessPass** – pass for the first sign-in, "Usable Once" on.
6. **Equipme › Update Employee Metadata** – store the Entra ID object ID on the employee so later flows can find the account unambiguously.

More about the process in equipme: [Onboarding and offboarding](https://hub.equipme.io/dokumentation/organization/employees/onboarding-and-offboarding.md).

### Offboarding: block access and free up licenses

1. **Scheduler** – daily.
2. **Equipme › List Employees** – employees in the status "offboarding", Output Type "One item at a time".
3. **Equipme › Get Employee Metadata** – read the stored Entra ID object ID.
4. **Microsoft Entra ID › UpdateUser** – "Account enabled" off.
5. **Microsoft Entra ID › RevokeUserSessions** – end all sessions.
6. **Microsoft Entra ID › RemoveLicense** – free up licenses.

### Monthly license report

1. **Scheduler** – monthly.
2. **Microsoft Entra ID › MonitorUnusedLicenses** – output **findings** with the list of blocked accounts that still hold licenses.
3. **Email › Send Email** – report to IT and controlling. Nothing needs to happen at the **ok** output.

## Notes and limitations

* *NewUser* polls Entra ID at regular intervals. Set "After" on the first start; otherwise the first run also reports existing users.
* *NewGroupMember* and *RemovedGroupMember* react to notifications from Microsoft and usually fire within a few seconds.
* *AddUser* returns the set or generated password in its result. Only pass it on through secure channels; for the first sign-in, a Temporary Access Pass is usually the better choice.
* Licenses can only be assigned if the user has a **usage location**.
* The monitor components for sign-ins and MFA (*MonitorInactiveUsers*, *MonitorStaleGuests*, *MonitorMfaRegistration*) need access to sign-in information; Microsoft usually requires an Entra ID P1 or P2 license for this.
* When you test a flow, the modifying actions do not write anything to Entra ID but return sample data.
* Deleted objects stay in the recycle bin for 30 days and can be restored with *RestoreDeletedItem* during this time.

## Troubleshooting

| Problem                                                       | Cause / solution                                                                                           |
| ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| Sign-in at "Connect account" fails or asks for admin approval | A Global Administrator must consent to the requested permissions in the tenant.                            |
| Error "Insufficient privileges" / "Forbidden"                 | The signed-in account lacks the required Entra ID role for this action, or the permission was not granted. |
| *AssignLicense* fails                                         | The user has no usage location, or no licenses are available (check *ListLicenses*).                       |
| *AddUser* reports a conflict                                  | The UPN or mail nickname is already taken, also in the recycle bin (*ListDeletedItems*).                   |
| *NewUser* does not fire                                       | Is the flow started? Is "After" in the future?                                                             |
| Group triggers do not fire                                    | Check the selected group; restart the flow after changes to the account.                                   |

You can find the logs of every run under **"Insights"**. For help, contact [support](https://hub.equipme.io/dokumentation/help/support.md).

## Frequently asked questions

**Can I connect several tenants?**

Yes. Create a separate connection for each tenant under "Accounts" and select the right connection in each component.

**How do I find the SKU IDs for&#x20;*****AssignLicense*****?**

With *ListLicenses*. The result contains the SKU ID, the name and the available units for every license.

**Does the connector replace HR-Sync?**

No. [HR-Sync](https://hub.equipme.io/dokumentation/organization/hr-sync.md) brings employee data into equipme. The Entra ID connector creates accounts and permissions in Microsoft – you can combine both in flows.


---

# 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://hub.equipme.io/dokumentation/automation/connectors/microsoft-entra-id.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.
