Skip to main content

Folder Template Creator OpenID Microsoft Guide

Raise a support ticket

OVERVIEW​

To use Microsoft Open ID with Folder Template Creator you are required to register the application on Azure Active Directory. The registration will be used to acquire an access token to requests to access the Folder Template Creator API.

APP REGISTRATION USING THE WEB PORTAL​

  1. Sign in to Azure web portal by clicking here

  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. Click on the New registration button

    image.png

  5. Enter Folder Template Creator into the name input field

    image.png

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

    image.png

  7. Select Single-page application (SPA) from the drop-down menu and type in the hostname configured for Folder Template Creator followed by /FolderTemplateCreator/

    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 hostname. Please include the trailing slash in the URL. Example: https://hostname/FolderTemplateCreator/

    image.png

  8. Click on the Register button

2022-10-14_17-00-13.png

EXPOSE THE API​

Applying a custom scope to the registration will prevent unauthorized access to the Folder Template Creator 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 on the Save button

    Note

    Do not Change the Application ID URI. It must be in the following format: api://{client id}

    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 Grant.Access

    FieldValue
    Scope NameGrant.Access
    Who can consent?Admins and users
    Admin Consent display nameGrant Access to Folder Template Creator
    Admin consent descriptionGrant Access to Folder Template Creator
    StateEnabled

    image.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 previously created Folder Template Creator Azure app registration

    image.png

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

    image.png

  11. Click on Grant admin consent

    image.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 required application ( Folder Template Creator created previously)

    image.png

  4. Click on Overview

    image.png

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

    image.png

  6. Click on Redirect URIs from the overview page

    image.png

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

image.png

VALUES REQUIRED FOR INSTALLATION​

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

  • Redirect URI
  • Application ID
  • Authorization URL
NameDescription
Redirect URIThe URI where Azure will send the authentication payload upon successful authentication.
Application IDApplication's unique identifier on AzureAD.
Authorization URLhttps://login.microsoftonline.com/\{Tenant ID}

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

CONFIGURATION​

The Authentication tab allows you to specify the authentication method for Folder Template Creator, and is available within the admin section of Folder Template Creator

2024-01-18_11-03-21.png

To enable Microsoft Open ID Authentication:

  1. Set the Type field to Microsoft.

  2. Enter the values for all the provided fields.

  3. Click Save

  4. Navigate to the Folder Template Creator application in IIS

  5. Ensure Anonymous Authentication is the only authentication method enabled for Folder Template Creator

    2024-01-18_11-13-30.png

  6. Perform an app pool restart for Folder Template Creator