Skip to main content

FYB Connect OpenID Microsoft Guide

Raise a support ticket

OVERVIEW​

To use Microsoft Open ID with FYB Connect you are required to modify the Content Manager application on Azure Active Directory. The registration will be used to acquire an access token to requests to access the FYB Connect and the CM Service API.

Note

This guide assumes your Content Manager Service API is protected by Microsoft OpenID.

You can configure Microsoft OpenID against your Service API by following the official guide provided by OpenText

UPDATE 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 the Content Manager Service API

  5. Click on the Authentication option

    2024-06-25_16-40-52.png

  6. In the Single-page application section, add the FYB Connect URL and click Save

    Note

    The redirect URI must be in lowercase

    2024-06-25_16-42-17.png

API PERMISSIONS​

  1. Navigate to the API permissions tab.

  2. Ensure the following OpenId delegate permissions have been added:

    image.png 2024-07-17_16-58-42.png

EXPOSE AN API​

Applying a custom scope to the registration will prevent unauthorized access to the FYB Connect API endpoints.

Note

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

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

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

  2. Next to the Application ID URI click on Set

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

  3. Click on the Save button

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

  4. Click Add a scope

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

  5. 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 nameGrant Access to FYB Connect
    Admin consent descriptionGrant Access to FYB Connect
    StateEnabled

    2024-10-15_15-01-12.png

  6. Once the scope has been added, click on API permissions

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

  7. Click on Add a permission

    image.png

  8. Click My APIs

    image.png

  9. Click on the Content Manager Azure app registration

    image.png

  10. Click on the user_impersonation scope and then click Add permissions at the bottom of the screen

    2024-10-15_15-02-54.png

  11. Click on Grant admin consent

    2024-10-15_15-04-02.png

CERTIFICATE BASED AUTHENTICATION​

Note

For the steps below, use the Entra application used for the Content Manager OpenId configuration

The background scheduler component of the application utilizes certificate-based authentication to verify its identity to Microsoft Azure. As such you will need to register a certificate for your application on Azure AD. You can choose to use an existing certificate if you have one (the same certificate used for the FYB Connect site) otherwise you can create/purchase a new certificate for this purpose. Please follow the steps below on how to upload a certificate:

  1. After obtaining a copy of your certificate (.pfx), install the certificate to the Certificate Manager tool under local machine on the server the application will be installed on

    Certificates

  2. Ensure the certificate has been given a friendly name, this is required when installing the app to the server

    2020-09-01_14-25-22.jpg

  3. Please ensure the account that will be running the application pool for the application has access to the certificate private key

  4. Right-click the certificate > All Task > Manage Private Key

    image.png

  5. Grant the account running the app pool full control permission on the certificate

  6. Export the public key from the certificate using this guide (https://docs.microsoft.com/en-us/azure/application-gateway/certificates-for-backend-authentication), you will only need to complete steps 1 to 7 in the Export authentication certificate (for v1 SKU) section

  7. Upload your certificate public key (.CER) to Microsoft Azure for the Content Manager application by going to the Certificates & secrets section

    Certificates2

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

    2024-10-01_12-15-14.png

  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, click Security

    2025-08-07_14-04-10.png

  9. Click Highest then click Ok

    2025-08-07_14-05-00.png

  10. 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

    image.png

  4. Click on Overview

    image.png

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

    2023-12-04_16-42-49.png

  6. Click on Redirect URIs from the overview page

    image.png

  7. And then copy and note down the Redirect URI value

2024-06-25_16-42-17.png

  1. Click on Expose an API

    2025-03-04_9-10-20.png

  2. Copy the value of the Application ID URI

    2025-03-04_9-11-18.png

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
  • Authorization URL
NameDescription
Application IDApplication's unique identifier on AzureAD.
Authorization URLhttps://login.microsoftonline.com/\{Tenant ID}
Application ID URIApplication ID URI of the registered Content Manager application.
Tenant IDThe organization tenant unique identifier on Azure Portal.
Certificate Friendly NameThe friendly name of the nominated certificate (.pfx) installed on the machine. This certificate is used to prove the application's identity by encrypting the application's claims in the form of a JWT token.

ENDPOINTS​

All valid endpoints for the registered application can be seen via the Azure web portal.

  1. Select the registered application on Azure

  2. From the Overview page select Endpoints

    2020-11-27_11-02-10.jpg