FYB Connect OpenID Microsoft Guide
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.
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
-
Sign in to Azure web portal using the link below https://azure.microsoft.com/en-gb/features/azure-portal/
-
Once signed in, click on the Azure Active Directory button

-
Click on the App Registrations option from the left menu

-
Locate the App Registration used to secure the Content Manager Service API
-
Click on the Authentication option

-
In the Single-page application section, add the FYB Connect URL and click Save
NoteThe redirect URI must be in lowercase

API PERMISSIONS
-
Navigate to the API permissions tab.
-
Ensure the following OpenId delegate permissions have been added:

EXPOSE AN API
Applying a custom scope to the registration will prevent unauthorized access to the FYB Connect API endpoints.
if the user_impersonation custom scope already exits, then the step below can be skipped
-
In the Left Menu, click on the Expose an API option

-
Next to the Application ID URI click on Set

-
Click on the Save button

-
Click Add a scope

-
Specify the values below in the Add a scope window, then click Add scope
NoteThe scope must be named user_impersonation
Field Value Scope Name user_impersonation Who can consent? Admins and users Admin Consent display name Grant Access to FYB Connect Admin consent description Grant Access to FYB Connect State Enabled 
-
Once the scope has been added, click on API permissions

-
Click on Add a permission

-
Click My APIs
-
Click on the Content Manager Azure app registration

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

-
Click on Grant admin consent

CERTIFICATE BASED AUTHENTICATION
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:
-
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

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

-
Please ensure the account that will be running the application pool for the application has access to the certificate private key
-
Right-click the certificate > All Task > Manage Private Key

-
Grant the account running the app pool full control permission on the certificate
-
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
-
Upload your certificate public key (.CER) to Microsoft Azure for the Content Manager application by going to the Certificates & secrets section

SETTING UP THE CM CONFIDENTIAL CLIENT LOCATION
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
-
In the App Registrations page, click on New Registration

-
Supply a name for the app and ensure the Single Tenant option is selected.
-
Click Register

-
Navigate to the API permissions section and click Add a permission

-
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)

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

-
Click Grant Permissions

CREATE THE LOCATION
-
Within the App Registrations section of Entra, click on Enterprise applications

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

-
Navigate to Content Manager
-
Create a new Person Location
-
Supply a name for the Location

-
On the Network Login tab, enable the Accept Logins option and supply a username
-
Paste the value copied in step 2 into the Alternative logins field

-
On the Profile tab, click Security

-
Click Highest then click Ok

-
Set the User Type as Administrator and click Ok

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.
-
Once signed into the Azure portal click on Azure Active Directory

-
Click on App registrations
-
Click on the Content Manager App registration
-
Click on Overview

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

-
Click on Redirect URIs from the overview page
-
And then copy and note down the Redirect URI value

-
Click on Expose an API

-
Copy the value of the Application ID URI

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
| Name | Description |
|---|---|
| Application ID | Application's unique identifier on AzureAD. |
| Authorization URL | https://login.microsoftonline.com/\{Tenant ID} |
| Application ID URI | Application ID URI of the registered Content Manager application. |
| Tenant ID | The organization tenant unique identifier on Azure Portal. |
| Certificate Friendly Name | The 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.
-
Select the registered application on Azure
-
From the Overview page select Endpoints

