Skip to main content

Explorezel Azure App Registration Guide

Raise a support ticket

OVERVIEW​

To use Explorezel you are required to register the application on Azure Active Directory. The application will be used to acquire an access token to make web API requests to access certain Microsoft resources for a tenant (organisation). The app is registered via the Azure Web portal

APP REGISTRATION​

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

  2. Once signed in, click on Azure Active Directory

    image.png

  3. Click on App Registrations from the left menu

    image.png

  4. Click on the New registration button

    image.png

  5. Enter Explorezel into the name input field

    2021-08-02_17-35-19.png

  6. Under Supported account types section enabled Accounts in this organizational directory option

    image.png

  7. Click on the Register button

AUTHENTICATION​

  1. Click AUTHENTICATION

    2021-08-02_17-37-19.png

  2. Under Platform configurations click Add a platform

    2021-08-02_17-38-51.png

  3. Click Single-page application

    2021-08-02_17-41-36.png

  4. For the Redirect URI field, type in the domain base URL configured for Explorezel followed by /Explorezel/

    Note

    The URI is case-sensitive, the route must match exactly the pattern below where the only variable that needs to be replaced is the domain. Please include the trailing slash in the URL. Example: https://[domain]/Explorezel/

    2021-08-02_17-45-44.png

  5. Click on the Configure button

    2021-08-02_17-46-58.png

GRANTING API PERMISSION​

The application will require various API permissions, please follow the steps below to add the required permission for Explorezel.

  1. Click on API permissions option from the left menu

    image.png

  2. Click on the Add Permissions button

    image.png  

  3. When the right-hand permission panel appears, click on Microsoft Graph (This will be at the very top)

    image.png

  4. Click on Delegated permission

    image.png

  5. Using the select permission window, add the following permissions to the application

  • Files.ReadWrite.All

  • Sites.Read.All

    image.png

  1. Scroll down to the bottom of the panel and click on the** Add Permission** button

    image.png  

  2. An Azure administrator will need to grant permission for the application to access the resources by clicking on the Grant Permission button

  3. Once granted the status will update to Green, indicating the permission has been successfully granted

    image.png

    Note

    Do not remove the default user.read delegated permission

    Note

    Note if users are still receiving the below message upon the first login then an Azure Administrator will need to complete the first login and grant consent from the Microsoft login pop-up instead.

    image.png

AZURE PERMISSIONS USAGE​

NAMETYPEDESCRIPTIONCONSENT REQUIREDUSAGE
Sites.Read.AllDelegatedRead items in all site collectionsYesThis permission is used to find documents across all sites in the tenant
Files.ReadWrite.AllDelegatedRead and write files in all site collectionsYesThis permission is required to query all documents across the tenant as well as edit and check-in documents via Explorezel

HOW TO GET THE APPLICATION ID​

Please follow the steps below to retrieve the application ID on the Azure portal. This is required for the installation.

  1. Once signed in to the Azure portal click on the Azure Active Directory button

    image.png

  2. Click on the App registrations option

    image.png

  3. Click on the required application (Explorezel created previously)

    2021-08-03_8-50-58.png

  4. Click on Overview

    2021-08-03_8-52-16.png

  5. Copy the Application (client) ID to the clipboard (you will need this value for the MSI)

    2021-08-03_8-53-49.png

HOW TO GET THE TENANT INFORMATION​

Please follow the steps below to retrieve the Tenant ID and Tenant Name on the Azure portal. This is required for the installation.

  1. Once signed in to the Azure portal click on Azure Active Directory

    image.png

  2. Click on Overview

    2020-08-25_11-20-46.png

  3. The Tenant ID can be found under the Tenant ID section and the Tenant Name can be found under the Primary Domain Section

    2020-08-25_11-23-10.png

VALUES REQUIRED FOR INSTALLATION​

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

  • Redirect URI
  • Application ID
  • Tenant ID
NameDescription
Redirect URIThe URI where Azure will send the authentication payload upon successful authentication. Please refer to the Redirect URI section to acquire the redirect URI.
Application IDApplication ID of the registered Explorezel application. Please refer to the HOW TO GET THE APPLICATION ID section for further info.
Tenant IDThe organization tenant's unique identifier on Azure Portal. Please refer to HOW TO GET THE TENANT INFORMATION section for further info.

REGISTERING CM LAUNCHER ON AZURE​

Like Explorezel, it is necessary to register the CM Launcher on Azure. This is required for real-time document synchronization when editing a document natively. Please refer to the dedicated CM Launcher Guide for further details.