Install MIM 2016 with SP2: MIM Service and Portal for Microsoft Entra ID P1 or P2 customers

Note

This walkthrough uses sample names and values from a company called Contoso. Replace these with your own. For example:

  • MIM Service and Portal server name - mim.contoso.com
  • SQL server name - contosoagl.contoso.com
  • Service account name - svcMIMService
  • Domain name - contoso
  • Password - Pass@word1

Before you begin

  • This guide is intended for installing MIM Service in organizations licensed for Microsoft Entra ID P1 or P2. If your organization does not have Microsoft Entra ID P1 or P2 or is not using Microsoft Entra ID, then you will need to instead follow installation guide for Volume License edition of MIM.
  • Ensure you have Microsoft Entra user credentials with enough permissions to validate that your tenant subscription includes Microsoft Entra ID P1 or P2 and can create app registrations.
  • If you plan to use Office 365 application context authentication, you will need to run a script to register the MIM Service application in Microsoft Entra ID and grant the MIM Service permissions to access a MIM Service mailbox in Office 365. Save the script output as you will need the resulting application ID and secret later during the installation.

Deployment options

Choices in deployment depend on two criteria:

  • Whether the MIM Service will be running as a regular Windows service account or as a group-managed service account (gMSA)
  • Whether the MIM Service will be sending email through an Exchange Server, Office 365, or an SMTP server

Available deployment options:

  • Option A: Regular service account + Exchange Server
  • Option B: Regular service account + Office 365 basic authentication
  • Option C: Regular service account + Office 365 application context authentication
  • Option D: Regular service account + SMTP
  • Option E: Regular service account + no mail server
  • Option F: Group-managed service account + Exchange Server
  • Option G: Group-managed service account + Office 365 basic authentication
  • Option H: Group-managed service account + Office 365 application context authentication
  • Option I: Group-managed service account + no mail server

Note

The SMTP server option only works with regular service accounts and Integrated Windows Authentication, and does not permit use of the Outlook add-in for approvals.

Preparing for Office 365 Application context authentication

Starting from build 4.6.421.0, in addition to basic authentication, the MIM Service supports application context authentication to Office 365 mailboxes. End of support for basic authentication was announced on 20 September 2019, therefore it is recommended to use application context authentication for sending notifications and collecting approval responses.

Application context authentication scenario requires you to register an application in Microsoft Entra ID, create a client secret to be used instead of a password and grant this application permission to access the MIM Service mailbox. The MIM Service will be using this application ID and this secret to access its mailbox in Office 365. You can register your application in Microsoft Entra ID either using a script (recommended) or manually.

Registering application using Microsoft Entra admin center

  1. Sign in to Microsoft Entra admin center with Global Administrator role.

  2. Navigate to Microsoft Entra blade and copy your Tenant ID from Overview section and save it.

  3. Navigate to App registrations section and click New Registration button.

  4. Give your application a name, for example, MIM Service mailbox client access, and click Register.

  5. After your application is registered, copy the Application (client) ID value and save it.

  6. Navigate to API Permissions section and revoke User.Read permission by clicking on three dots right to permission name and choosing Remove Permission. Confirm that you want to remove this permission.

  7. Click on Add a permission button. Switch to APIs my organization uses and type Office. Select Office 365 Exchange Online and Application permissions type. Type full and select full_access_as app. Click Add Permissions button.

  8. You will see permission added and that admin consent is not granted. Click on Grant admin consent button next to Add a permission button.

  9. Navigate to Certificates and secrets and choose to add New client secret. If you select an expiration time for the secret, you will have to reconfigure MIM Service closer to its expiration date to use another secret. If you do not plan to rotate application secrets, select Never. Give your secret a name, for example, MIM Service and click Add button. You will see the secret value displayed in the portal. Copy this value (not secret ID) and save it.

  10. Now that you have Tenant ID, Application ID and application secret needed by installer you can continue with MIM Service and Portal installation. In addition, you may want to restrict access of your newly registered application to MIM Service mailbox only (full_access_as_app grants access to all mailboxes in your organization). To do so, you need to create an application access policy. Follow this guide to restrict access of your application to the MIM Service mailbox only. You will need to create a distribution or mail-enabled security group and add your MIM Service mailbox into that group. Then run a PowerShell command and provide your Exchange Online administrator credentials:

    New-ApplicationAccessPolicy `
    -AccessRight RestrictAccess `
    -AppId "<your application ID from step 5>" `
    -PolicyScopeGroupId <your group email> `
    -Description "Restrict MIM Service app to members of this group"
    

Registering application using a PowerShell script

Create-MIMMailboxApp.ps1 script could be found either in Scripts.zip/Scripts/Service and Portal or in Service and Portal.zip\Service and Portal\Program Files\Microsoft Forefront Identity Manager\2010\Service\Scripts.

Unless your MIM Service mailbox is hosted in a national or government cloud, the only parameter you need to pass to the script is MIM Service email, for example, MIMService@contoso.onmicrosoft.com.

From a PowerShell window start Create-MIMMailboxApp.ps1 with -MailboxAccountEmail <email> parameter and provide MIM Service email.

./Create-MIMMailboxApp.ps1 -MailboxAccountEmail <MIM Service email>

When asked for credentials, provide your Microsoft Entra Global Administrator credentials to register an application in Azure.

Once the application is registered, another popup will ask for Exchange Online Administrator credentials to create an application access policy.

After successful application registration your script output should look like this:

PowerShell script output image

There is a 30-second delay after the application is registered and a browser window is opened to avoid replication issues. Provide your Microsoft Entra tenant administrator credentials and accept a request to grant your application access to the MIM Service mailbox. The popup window should look like this:

Admin consent screen image

After you click Accept button, you will be redirected to Microsoft 365 admin center. You can close the browser window and check the script output. It should look like this:

Final PowerShell script output image

Copy ApplicationId, TenantId, and ClientSecret values as they will be needed by the MIM Service and Portal installer.

Deploying MIM Service and Portal

Common deployment steps

  1. Create a temporary directory to keep installer logs in, for example, c:\miminstall.

  2. Start elevated command prompt, navigate to MIM Service installer binaries folder and run:

    msiexec /i "Service and Portal.msi" /lvxi* c:\miminstall\log.txt
    

    In the welcome screen, click Next.

    Welcome screen image

  3. Review the End-User License Agreement and click Next if you accept the license terms.

    End-User License Agreement screen image

  4. National clouds are isolated instances of Azure. Select which Azure Cloud instance your tenant is hosted in and click Next.

    Azure instance selection screen image

    Organizations which are not using a national or government cloud should select the global instance, Microsoft Entra ID.

    Azure instance selected screen image

  5. After selecting the appropriate cloud, the installer will ask you to authenticate to that tenant. In the popup window, provide Microsoft Entra user credentials of a user in that tenant to validate your tenant subscription level. Type your Microsoft Entra username and click Next.

    Sign-in popup window account name image

    Type your password and click Sign In.

    Sign-in popup window password image

    If the installer is unable to locate a subscription to Microsoft Entra ID P1 or another subscription, which includes Microsoft Entra ID P1 or P2, you will see a popup error. Check that the username is for the correct tenant and look at the installer log file for more information.

  6. Once the license check is complete, select MIM Service and Portal components to install and click Next.

    MIM Service Component selection screen image

  7. Provide the SQL server and database name. Choose to reuse the existing database if upgrading from previous MIM versions. If installing using SQL failover cluster or Always-On Availability Groups Listener, provide a cluster or a listener name. Click Next.

    Configure the MIM database connection screen image

  8. If installing MIM using an existing database, a warning appears. Click Next.

    SQL Warning message screen image

  9. Choose a combination of mail server type and authentication method (options A-I, see below)

    General Mail service type selection screen image General Authentication type selection screen image

    If installing MIM Service using Group-Managed Service Account, then select the corresponding checkbox, otherwise leave this checkbox unchecked. Click Next.

    Group managed service account selection screen image 1

    If you select incompatible combination of mail server type and authentication method, after you click Next, a popup error appears.

    Incompatible combination popup error screen image

Option A. Regular service account + Exchange Server

  1. On the Configure common services page select Exchange Server 2013 or later and Integrated Windows Authentication. Type your Exchange server hostname. Leave Use Group Managed Service Account checkbox unchecked. Click Next.

    Mail service type selection screen image - option A

  2. If installing MIM Reporting component, type System Center Service Manager management server name and click Next.

    SCSM server name screen image - option A

  3. If installing MIM Reporting component in TLS 1.2 only environment with System Center Service Manager 2019, choose a certificate trusted by SCSM Server with MIM server hostname in certificate’s subject, otherwise choose to generate a new self-signed certificate. Click Next.

    Certificate selection screen image - option A

  4. Type MIM Service account name and password, domain name and MIM Service mailbox SMTP address. Click Next.

    Configure the MIM service account image - option A

Option B. Regular service account + Office 365 basic authentication

  1. On the Configure common services page select Office 365 mail service and Basic Authentication. Leave Use Group Managed Service Account checkbox unchecked. Click Next.

    Mail service type selection screen image - option B

  2. If installing MIM Reporting component, type System Center Service Manager management server name and click Next.

    SCSM server name screen image - option B

  3. If installing MIM Reporting component in TLS 1.2 only environment with System Center Service Manager 2019, choose a certificate trusted by SCSM Server with MIM server hostname in certificate’s subject, otherwise choose to generate a new self-signed certificate. Click Next.

    Certificate selection screen image - option B

  4. Type MIM Service account name and password, domain name, MIM Service’s Office 365 mailbox SMTP address and MIM Service mailbox Microsoft Entra password. Click Next.

    Configure the MIM service account image - option B

Option C. Regular service account + Office 365 application context authentication

  1. On the Configure common services page select Office 365 mail service and Application Context Authentication. Leave Use Group Managed Service Account checkbox unchecked. Click Next.

    Mail service type selection screen image - option C

  2. If installing MIM Reporting component, type System Center Service Manager management server name and click Next.

    SCSM server name screen image - option C

  3. Provide the Microsoft Entra Application ID, Tenant ID and Client Secret, that were generated by a script earlier. Click Next.

    Microsoft Entra Application ID, Tenant ID, and client secret screen image - option C

    If installer fails to validate the Application ID or Tenant ID, an error appears:

    Failed validation popup error screen image - option C

    If installer fails to access MIM Service mailbox, another error appears:

    Failed authentication popup error screen image - option C

  4. If installing MIM Reporting component in TLS 1.2 only environment with System Center Service Manager 2019, choose a certificate trusted by SCSM Server with MIM server hostname in certificate’s subject, otherwise choose to generate a new self-signed certificate. Click Next.

    Certificate selection screen image - option C

  5. Type MIM Service account name and password, domain name and MIM Service’s Office 365 mailbox SMTP address. Click Next.

    Configure the MIM service account image - option C

Option D. Regular service account + SMTP server

  1. On the Configure common services page select SMTP and Integrated Windows Authentication. Type SMTP server hostname. Leave Use Group Managed Service Account checkbox unchecked. Click Next.

    Mail service type selection screen image - option D

  2. If installing MIM Reporting component, type System Center Service Manager management server name and click Next.

    SCSM server name screen image - option D

  3. If installing MIM Reporting component in TLS 1.2 only environment with System Center Service Manager 2019, choose a certificate trusted by SCSM Server with MIM server hostname in certificate’s subject, otherwise choose to generate a new self-signed certificate. Click Next.

    Certificate selection screen image - option D

  4. Type MIM Service account name and password, domain name and MIM Service SMTP address. Click Next.

    Configure the MIM service account image - option D

Option E. Regular service account + no mail server

  1. On the Configure common services page select None server type. Leave Use Group Managed Service Account checkbox unchecked. Click Next.

    Mail service type selection screen image - option E

  2. If installing MIM Reporting component, type System Center Service Manager management server name and click Next.

    SCSM server name screen image - option E

  3. If installing MIM Reporting component in TLS 1.2 only environment with System Center Service Manager 2019, choose a certificate trusted by SCSM Server with MIM server hostname in certificate’s subject, otherwise choose to generate a new self-signed certificate. Click Next.

    Certificate selection screen image - option E

  4. Type MIM Service account name and password, domain name. Click Next.

    Configure the MIM service account image - option E

Option F. Group-managed service account + Exchange Server

  1. On the Configure common services page select Exchange Server 2013 or later and Integrated Windows Authentication. Type your Exchange server hostname. Enable Use Group Managed Service Account option. Click Next.

    Mail service type selection screen image - option F

  2. If installing MIM Reporting component, type System Center Service Manager management server name and click Next.

    SCSM server name screen image - option F

  3. If installing MIM Reporting component in TLS 1.2 only environment with System Center Service Manager 2019, choose a certificate trusted by SCSM Server with MIM server hostname in certificate’s subject, otherwise choose to generate a new self-signed certificate. Click Next.

    Certificate selection screen image - option F

  4. Type MIM Service group-managed service account name, domain name, MIM Service mailbox SMTP address and password. Click Next.

    Configure the MIM service account image - option F

Option G. Group-managed service account + Office 365 basic authentication

  1. On the Configure common services page select Office 365 mail service and Basic Authentication. Enable Use Group Managed Service Account option. Click Next.

    Mail service type selection screen image - option G

  2. If installing MIM Reporting component, type System Center Service Manager management server name and click Next.

    SCSM server name screen image - option G

  3. If installing MIM Reporting component in TLS 1.2 only environment with System Center Service Manager 2019, choose a certificate trusted by SCSM Server with MIM server hostname in certificate’s subject, otherwise choose to generate a new self-signed certificate. Click Next.

    Certificate selection screen image - option G

  4. Type MIM Service group-managed service account name, domain name, MIM Service’s Office 365 mailbox SMTP address and the MIM Service account’s Microsoft Entra password. Click Next.

    Configure the MIM service account image - option G

Option H. Group-managed service account + Office 365 application context authentication

  1. On the Configure common services page select Office 365 mail service and Application Context Authentication. Enable Use Group Managed Service Account option. Click Next.

    Mail service type selection screen image - option H

  2. If installing MIM Reporting component, type System Center Service Manager management server name and click Next.

    SCSM server name screen image

  3. Provide the Microsoft Entra Application ID, Tenant ID and Client Secret, that were generated by a script earlier. Click Next.

    Microsoft Entra Application ID, Tenant ID and client secret screen image - option H

    If installer fails to validate the Application ID or Tenant ID, an error appears:

    Failed validation popup error screen image - option H

    If installer fails to access MIM Service mailbox, another error appears:

    Failed authentication popup error screen image - option H

  4. If installing MIM Reporting component in TLS 1.2 only environment with System Center Service Manager 2019, choose a certificate trusted by SCSM Server with MIM server hostname in certificate’s subject, otherwise choose to generate a new self-signed certificate. Click Next.

    Certificate selection screen image - option H

  5. Type MIM Service group-managed service account name, domain name and MIM Service Office 365 mailbox SMTP address. Click Next.

    Configure the MIM service account image - option H

Option I. Group-managed service account + no mail server

  1. On the Configure common services page select None server type. Enable Use Group Managed Service Account option. Click Next.

    Mail service type selection screen image - option I

  2. If installing MIM Reporting component, type System Center Service Manager management server name and click Next.

    SCSM server name screen image - option I

  3. If installing MIM Reporting component in TLS 1.2 only environment with System Center Service Manager 2019, choose a certificate trusted by SCSM Server with MIM server hostname in certificate’s subject, otherwise choose to generate a new self-signed certificate. Click Next.

    Certificate selection screen image - option I

  4. Type MIM Service group-managed service account name, domain name. Click Next.

    Configure the MIM service account image - option I

Common deployment steps. Continuation

  1. If MIM Service account was not restricted to deny local logons a warning message appears. Click Next.

    Warning screen image 2

  2. Type MIM Synchronization Server hostname. Type MIM Management Agent account name. If you are installing MIM Synchronization Service using Group-Managed Service Account, then add the dollar sign to the account name, for example, contoso\MIMSyncGMSAsvc$. Click Next.

    Synchronization Server name screen image

  3. Type MIM Service Server hostname. In a case a load-balancer is used to balance MIM Service payload, provide the name of the cluster. Click Next.

    MIM Service Server name screen image

  4. Provide SharePoint site collection name. Make sure to replace http://localhost with a proper value. Click Next.

    SharePoint site collection URL screen image

    A warning appears. Click Next.

    SharePoint Timer warning message screen image

  5. If installing Self-Service Password Registration website (not needed if you are using Microsoft Entra ID for password reset), specify a URL MIM clients will be redirected to after logon. Click Next.

    Self-Service Password Registration URL screen image

  6. Select the checkbox to open ports 5725 and 5726 in the firewall, and the checkbox to grant all authenticated users access to MIM Portal. Click Next.

    Firewall configuration screen image

  7. If installing Self-Service Password Registration website (not needed if you are using Microsoft Entra ID for password reset), set the application pool account name and its password, the host name and the port for the website. Enable the Open port in firewall option if needed. Click Next.

    Password registration portal configuration screen image

    A warning will appear – read it and click Next.

    Password Registration warning message screen image

  8. In the next MIM Password Registration Portal configuration screen, type the MIM Service Server Address for the Password Registration Portal and select whether this website will be accessible by intranet users. Click Next.

    Password registration portal service configuration screen image

  9. If installing Self-Service Password Reset website, set the application pool account name and its password, the host name and the port for the website. Enable the Open port in firewall option if needed. Click Next.

    Password Reset portal configuration screen image

    A warning will appear – read it and click Next.

    Password Reset portal warning message screen image

  10. In the next MIM Password Reset Portal configuration screen, type the MIM Service Server Address for the Password Reset Portal and select whether this website will be accessible by intranet users. Click Next.

    Password Reset portal service configuration screen image

  11. When all pre-installation definitions are ready, click Install to begin installing the selected Service and Portal components. MIM Service and Portal installation screen image - final

Post-installation tasks

After installation completes, verify that the MIM Portal is active.

  1. Launch Internet Explorer and connect to the MIM Portal on http://mim.contoso.com/identitymanagement. Note, that there may be a short delay on the first visit to this page.

    • If necessary, authenticate as a user, that installed MIM Service and Portal, to Internet Explorer.
  2. In Internet Explorer, open the Internet Options, change to the Security tab, and add the site to the Local intranet zone if it is not already there. Close the Internet Options dialog.

  3. In Internet Explorer, open the Settings, change to the Compatibility view settings tab, and uncheck Display Intranet Sites in Compatibility view checkbox. Close Compatibility View dialog.

  4. Enable non-administrators to access MIM Portal.

    1. Using Internet Explorer, in MIM Portal, click on Management Policy Rules.
    2. Search for the management policy rule, User management: Users can read attributes of their own.
    3. Select this management policy rule, uncheck Policy is disabled.
    4. Click OK and then click Submit.

Note

Optional: At this point you can install MIM add-ins and extensions and language packs.