Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Go to the Azure portal: https://portal.azure.com/#home

  2. Select Microsoft Entra ID in the menu

    Image RemovedImage Added
  3. Go to App Registrations and click on New Registration.

    Image RemovedImage Added
  4. Insert the application's name (e.g. piplanning app) and the callback URL.

    Please note: Depending on how your Microsoft Entra ID is configured and which users you want to give access to the piplanning app, you might have to select a different option in the Supported account types section. If login for some users doesn't work, try changing this configuration option.


    The callback URL can be found on the "Identity Provider" page in the Cockpit.

  5. Double-check that the permissions are correct. You need the Microsoft Graph User.Read permissions to log in successfully. If you want to map Microsoft Entra ID groups to piplanning app teams automatically, you need to add Microsoft Graph Group.Read.All permissions as well.

  6. Next is the creation of a client secret. This can be done by going to the "Certificates & Secrets" menu item and clicking on "New client secret"

    Image RemovedImage Added
  7. The secret can now be copied and saved. This information is needed in the piplanning app to set the Identity Provider.

...

  1. Login to the Cockpit and click the "Identity Provider" menu item. The OpenID Connect configuration”

    Image Removed

    configuration page will open.

    Image Added
  2. Fill in a connection name of your choice. This name will appear on your users' login button. (e.g. "Microsoft Entra ID")

  3. Leave the "Automatically discover endpoints" option enabled and enter as Issuer the following URL: https://login.microsoftonline.com/{tenantId}/v2.0
    The tenant ID must be substituted with the value found on the Microsoft Entra ID application registration overview as Directory (tenant) ID:

    Image Added

    Please note: Depending on your configuration, you might have to use the older API version. If login doesn't work with your setup, try to remove /v2.0 from the issuer URL:
    https://login.microsoftonline.com/{tenantId}

  4. Fill in the client ID that you can also find in the application registration overview as Application (client) ID

  5. Fill in the client secret from the value you previously generated under "Certificates & Secrets"

  6. Fill the Scope field with the following values: openid email profile

  7. At this point, the form should be complete, and the connection should be saved by clicking "Save."

    image-20240927-130904.pngImage Added

  8. If you want to automatically map Microsoft Entra ID groups to piplanning app teams, you need to add a “groups“ value to the Groups Claim field. For a Group claim to work correctly, you need to use v2.0 at the end of the Issuer string. Older versions are not supported. (Example: https://login.microsoftonline.com/<id>/v2.0)

    image-20240820-121501.pngImage Added


    The login screen will now add the option to log in with Microsoft Entra ID.

...

image-20240820-121604.pngImage Added

FAQ

Q: During login, I get the error: "A request to the OpenID Connect Token API has failed. Unable to complete this login request" [Backend error: AADSTS700025 - invalid_client]
A: Make sure you have selected "Web" (instead of a single page application) for the redirect URI in Azure.