Skip to main content

Microsoft Entra ID

The Omada Microsoft Entra ID connectivity supports governing and managing Microsoft Entra ID instances. It is based on Microsoft Graph API. By using this package you can:

  • Register and onboard any number of Microsoft Entra ID instances.
  • Load information about Users, Groups, group memberships, and used licenses.
  • Automate the provisioning and de-provisioning of Microsoft Entra ID users, groups (Security, Teams, and SharePoint), and memberships.

Each Microsoft Entra ID instance must be onboarded in a separate onboarding process.

Supported objects and operations

The Omada Microsoft Entra ID Connectivity allows you to manage both identity data and access rights. However, the default mappings are provided only for access rights as this connectivity is typically used for that type of data.

ObjectPossible operations
UsersCreate, read, update, delete **
User passwordsCreate, update
Security groupsCreate, read, update, delete
Distribution groupsRead*
Mail-enabled groupsRead*
Sharepoint sites***Create, read, update, delete
TeamsCreate, read, update, delete
ChannelsRead
Security group membershipsCreate, read, delete
Distribution group membershipsRead*
Mail-enabled group membershipsRead*
Team group membershipsCreate, read, delete
Sharepoint group membershipsCreate, read, delete
Directory rolesRead
Directory roles AssignmentsCreate, read, update, delete

(*) The Microsoft Graph API does not provide support for provisioning of distribution groups and mail-enabled security groups. See the Microsoft Exchange Online/Hybrid connectivity section for details how to manage these groups.
(**) When a user is deleted from Microsoft Entra ID, Omada automatically revokes sign-in sessions for the deleted user. If revoking the sign-in session fails for any reason, Omada logs a warning for the task. This functionality is available without any additional configuration.
(***) Due to the lack of support for the POST method in the direct sites creation via the Microsoft Graph API, the creation of Microsoft 365 groups is used as an effective alternative. This process not only creates a group, but it also provisions an associated team site in SharePoint.

In addition, Microsoft Entra ID Connectivity supports the following scenarios:

  • Extraction of assignments between:
    • Directory roles and users
    • Teams groups, members, and owners
    • SharePoint groups, members, and owners
    • Security groups, members, and owners
    • Distribution groups, members, and owners
    • Mail-enabled Security groups, members, and owners
    • Groups
  • Extraction of Teams Channels and parent/child between Teams and Channels
  • Extraction of resource owners of each group (Teams, SharePoint, Security, Distribution, Mail-enabled Security)
  • Extraction of Stock Keeping Units (SKUs) and included service plans
  • Extraction of user’s assigned licenses
  • Extraction of user's assigned service plans
  • Extraction of user accounts
    • Sign-in activity
  • User provisioning
    • Password reset
  • Groups provisioning
    • Teams groups
    • SharePoint groups
    • Security groups
  • Assignments
    • Add and remove assignments between groups (Security, Teams and SharePoint) and users
    • Add and remove assignments between directory roles and users

Minimum required permissions

None.

Implementation notes

The Microsoft Entra ID connectivity package only includes directory roles that are enabled. You must create and enable directory roles - both custom directory roles and from templates – in the Microsoft Azure Portal.

Microsoft Graph API does not currently support the provisioning of SharePoint Sites. As a workaround, provision SharePoint Sites associated with the Microsoft Entra ID groups.

Omada does not facilitate the upgrade of SharePoint groups to Teams groups.


Prerequisites

Before importing information from Microsoft Entra ID to Omada Identity, perform the following setps in the Microsoft Azure Portal.

Register a new application in Azure Portal

Create an application registration to authenticate and authorize Omada Identity with Microsoft Entra ID:

  1. In the Azure portal, go to your directory. In the Manage section, find the App registrations, then click New registration.

  2. In the Register an application dialog box, enter a Name, select Accounts in any organizational directory as Supported account types, and enter a Redirect URI. You can enter any value that you want to use, as long as it is in a valid URL format.

  3. Click Register. Copy and store the Application ID. You must use this Application ID when you onboard the system to Omada Identity.

    info

    The Application ID shown in the following image is only an example. Your Application ID contains a different value.

Add Graph API

The connectivity uses the Microsoft Graph API to read and write information to the directory. Add the Graph API for the registered application:

  1. Go to API permissions and select +Add a permission.

  2. Choose Microsoft Graph from Commonly used Microsoft APIs (from the Supported legacy APIs) and click Select.

  3. Select all needed Application permissions.

  4. Click the Add permissions button.

    The table below presents the minimum required permissions for the correct connection between Microsoft Entra ID and Omada Identity.

    MICROSOFT GRAPH

    PermissionTypeDescription
    Group.Read.AllApplicationEnables reading group data.
    Group.ReadWrite.AllApplicationAllows reading and modifying groups.
    User.Read.AllApplicationProvides access to user profiles and attributes.
    User.ReadWrite.AllApplicationEnables reading and updating user profiles and attributes.
    RoleManagement.Read.DirectoryApplicationRequired for reading role assignments in the directory.
    RoleManagement.ReadWrite.DirectoryApplicationAllows reading and modifying role assignments in the directory.
    Team.ReadBasic.AllApplicationEnables reading basic information about teams.
    Channel.ReadBasic.AllApplicationProvides access to basic channel information.
    TeamMember.Read.AllApplicationAllows reading team member data.
    TeamMember.ReadWrite.AllApplicationEnables reading and updating team member data.
    Team.CreateApplicationNecessary for creating new teams within the organization.
    GroupMember.ReadWrite.AllApplicationAllows modifying group memberships.
    Sites.Read.AllApplicationGrants access to read site-related data.
    Organization.Read.AllApplicationRequired to read organizational structure and data.
    AuditLog.Read.AllApplicationAllows access to read audit logs for security and compliance. Used to read the SignInActivity field found in the Q&M section of accounts.
  5. After adding the permission, grant consent to the permissions. Click the Grant admin consent button.

Create a client secret or a certificate

Credentials are used by confidential client applications that access a web API, and they allow the application to authenticate as itself, requiring no interaction from the user at runtime.

Client secret

  1. Go to Certificates & secrets select + New client secret.

  2. Enter a description for the secret key. It helps identify one secret key from other keys.

  3. Optionally, choose the expiration time for the secret. Click Add.

  4. Copy the generated key shown under Value. You cannot see the value again one you exit the screen. Copy the key now and paste it in Omada Identity after setting up the Omada Identity application in Azure.

  5. Microsoft Entra ID is now ready to be registered with Omada Identity. You can create as many secret keys as you require.

Certificate

  1. Go to Certificates & secrets. Select Certificates.
  2. Select Upload certificate. Choose the certificate file to upload. Click Add. Once the certificate is uploaded, the details are displayed.
  3. Your Microsoft Entra ID is now ready to be registered with Omada Identity.

Assigning User Account Administrator role (for user/group deletion and password reset)

Allow password reset and deletion of users and group assignments in Microsoft Entra ID

To delete a user or group in Microsoft Entra ID, you must first assign your application’s principal a User Account Administrator role. If you use Microsoft Graph, perform the same operation for the password reset to work. Choose one of the following options:

  1. Go to https://portal.azure.com.

  2. Click Microsoft Entra ID.

  3. Click Roles and administrators.

  4. Click User administrator role.

  5. Click + Add assignments.

  6. In the search box, enter the name of the application you have created in the Register a new application in Azure Portal step.

  7. Click Add.