Skip to main content

DocUMove OpenID Microsoft Guide

Raise a support ticket

OVERVIEW​

To use Microsoft Entra ID with FYB DocUMove, an Entra ID Active Directory App Registration is required. The registration will be used to acquire an access token to make requests to access the FYB DocUMove and the CM Service API.

Note

This configuration is only required if you would like to secure your DocUMove instance using Microsoft Entra ID.

CREATE THE 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 Microsoft Entra ID button

    Enta ID.png

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

    image.png

  4. Click on the New Registration option from the options near the top of the page

New Registration.png

  1. Enter the name you would like to use for the App Registration

    Register an Application - Name.png

  2. Within the Redirect URI (Optional) section, select Single-page application for the platform and add the FYB DocUMove URL and click Save

    Note

    The redirect URI must be in lowercase

    Register an Application - Redirect URI.png

API PERMISSIONS​

  1. Navigate to the API permissions tab.

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

    image.png API Permissions.png

EXPOSE AN API​

Applying a custom scope to the registration will prevent unauthorised access to the FYB DocUMove API endpoints.

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

    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 Save

    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 DocUMove
    Admin consent descriptionGrant Access to FYB DocUMove
    User Consent display nameGrant Access to FYB DocUMove
    User consent descriptionGrant Access to FYB DocUMove
    StateEnabled

    Add a Scope.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 DocUMove app registration

    My APIs.png

    Note

    If your app registration is not listed, wait 5-10 minutes or search for the app registration using the within the APIs my organization uses tab

    APIs my organization uses.png

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

    user_impersonation.png

  11. Click on Grant admin consent

    Grant admin consent.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 your DocUmove App registration

    DocUMove App Registration.png

  4. Click on Overview

    image.png

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

    App Details.png

  6. Copy the value of the Application ID URI

    AppIDURI.png

  7. Click on Redirect URIs from the overview page

    image.png

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

Redirect URI.png

VALUES REQUIRED FOR INSTALLATION​

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

NameDescription
Client IDApplication's unique identifier on AzureAD.
Authority URLhttps://login.microsoftonline.com/\{Tenant ID}
App ID URIApplication ID URI of the registered application.
Tenant IDThe organisation tenant unique identifier on Azure Portal.

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

    DocUMove EndPoints.png