Skip to main content

OpenID Confidential Client - Microsoft Guide

Raise a support ticket

OVERVIEW​

When using Content Manager with only OpenID Authentication enabled, a Confidential Client is required to be configured for FYB Software applications to Authenticate.

Note

This configuration is only required if your Content Manager dataset has Windows Authentication disabled, and Microsoft EntraID enforced

MODIFY THE CONTENT MANAGER APP REGISTRATION​

  1. Sign in to Azure web portal using the link below https://azure.microsoft.com/en-gb/features/azure-portal/

  2. Once signed in, click on the Azure Active Directory button

    image.png

  3. Click on the App Registrations option from the left menu

    image.png

  4. Locate the App Registration used to secure Content Manager

    Note

    if the user_impersonation custom scope already exits, then the step below can be skipped

  5. In the Left Menu, click on the Expose an API option

    2022-08-04_11-11-50.png

  6. Next to the Application ID URI click on Set

    2022-08-04_11-13-18.png

  7. Click on the Save button

    2022-08-04_11-14-32.png

  8. Click Add a scope

    2022-08-04_11-17-32.png

  9. Specify the values below in the Add a scope window, then click Add scope

    Note

    The scope must be named user_impersonation

    FieldValue
    Scope Nameuser_impersonation
    Who can consent?Admins and users
    Admin Consent display nameAllow SDK Applications To Impersonate Users
    Admin consent descriptionAllow SDK Applications To Impersonate Users
    StateEnabled

    Impersonate User Scope.png

  10. Click Save

SETTING UP THE CM CONFIDENTIAL CLIENT LOCATION​

Note

If you already have Content Manager Confidential Client location configured then these steps can be skipped

The Content Manager Confidential Client location will allow FYB Connect to connect to Content Manager as the Service Account during the background scheduling process.

CREATE AN AZURE APPLICATION​

  1. In the App Registrations page, click on New Registration

    2024-10-01_11-57-52.png

  2. Supply a name for the app and ensure the Single Tenant option is selected.

  3. Click Register

    2024-10-01_12-06-26.png

  4. Navigate to the API permissions section and click Add a permission

    2024-10-01_12-10-06.png

  5. Under the My APIs section, select the app used to secure the Content Manager Service API (the same app used in the MODIFY THE APP REGISTRATION section)

    2024-10-01_12-11-24.png

  6. Select the permission configured for the Content Manager Azure app and click Add permissions

    Add Permission.jpg

  7. Click Grant Permissions

    2024-10-01_12-20-03.png

CREATE THE LOCATION​

  1. Within the App Registrations section of Entra, click on Enterprise applications

    2024-10-01_12-21-33.png

  2. Navigate to the application created in the previous section and copy the Object Id value

    2024-10-01_12-25-23.png

  3. Navigate to Content Manager

  4. Create a new Person Location

  5. Supply a name for the Location

    2024-10-01_12-28-47.png

  6. On the Network Login tab, enable the Accept Logins option and supply a username

  7. Paste the value copied in step 2 into the Alternative logins field

    2024-10-01_12-36-20.png

  8. On the Profile tab, set the User Type as Administrator and click Ok

    2024-10-01_12-38-38.png

GATHERING APP DETAILS​

Please follow the steps below to retrieve the Application ID, Tenant ID and Redirect URL on the Azure portal. These values are required for the installation.

  1. Once signed into the Azure portal click on Azure Active Directory

    image.png

  2. Click on App registrations

    image.png

  3. Click on the Content Manager App registration

    CM Registration.png

  4. Click on Overview

    image.png

  5. Copy the Application (client) ID and Application ID URI and note them down.

    APP ID.jpg

  6. Go back to App Registrations and click on the Confidential Client App Registration

    CC Registration.png

  7. Click on Overview and copy the Application (Client) ID and note it down

    APP ID - CC.jpg

CONFIGURE CONFIDENTIAL CLIENT IN ENTERPRISE STUDIO​

  1. Log on to the CM Server and open Content Manager Enterprise Studio

  2. Right Click on the required dataset and select Properties

  3. Navigate to the Authentication tab and select Add from the OpenID Confidential Clients section

    Add CC.jpg

  4. Enter the details as per the below table:

    FieldValue
    Client IDThe Application ID of the Confidential Client App Registration created above
    ScopeThe Application ID URI of the CM App Registration, but with "/.default" appended.
    CC Details.jpg
  5. Click OK to save and then Test to confirm the Confidential Client is working. Enter the Client Secret from the Confidential Client App Registration when prompted to test.

  6. Once tested successfully, click OK and then perform a Save and Deploy to save the changes to CM

VALUES REQUIRED FOR INSTALLATION​

The following values will be required for the installation of FYB Connect. Please ensure that the person responsible for the installation has these values.

  • Application ID
  • Client Secret
  • Network Login of Confidential Client Location

Once the above has been completed, you can continue with the installation of your FYB Software