Requirements for this guide:
- Your domain and your tenant ID for Flip AI. Your contact person at Flip AI can provide you this information.
- You have access to the Azure portal at https://portal.azure.com.
- You are entitled to access the overview of and to register new apps at https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade.
To use Flip AI with your existing Azure instance, Flip AI must be registered as a new app. After this step, the app can be configured to use Single Sign-On (SSO). We will guide you through the individual steps in our step-by-step guide.
Create an App registration
The first step is to register a new app in Azure. Use the search box (1) and select “App registrations” (2) to go to the overview of all current registered apps.
Then simply click “New registration” (3). You will be forwarded to a form.
Fill out the form with the following details:
- The name of the new application (1). Use a name which enables you to identify Flip AI at any time. In this example, we’re simply using “Flip AI”.
- The account type (2). In most cases, the first option, “Single tenant”, is enough. Please select the needed option for your case.
Click “Register” to have the new app registered.
Create a user to let Flip AI test SSO with your tenant
Please provide a test user to let Flip AI test the SSO process and configuration. Do ensure that testing is possible without any multifactor authentication obligations.
Switch to the user administration by searching (1) and clicking on “User” (2). Then click on “+ New user / Create new user” to open a form.
Please note: select the correct user navigation entry (blue icon).
Give the user a username that indicates their intended use (1).
Please note the user principal name and the password (2) to let Flip AI test the SSO configuration with your tenant.
Also ensure that the user is activated (3) and click on “Review + create” (4).
Important: Add the user to the group intended to act as the user base.
Add a client secret
Please note: if you’ve created an Enterprise application, you have to switch to “App registrations” first. Then select your application.
Be sure that you are within the configuration section of your new Flip AI app registration and click on “Certificates & secrets” (1) in the navigation bar on the left.
Then simply click on “New client secret” (2) and a simple form will be displayed on the right side.
Provide your information (3):
- Description: Use a name which enables you to identify what this secret is used here, e.g., “Flip AI SSO” or something similar. In our example, we simply use “Client for Flip AI”.
- Expiration period: Select a period for the secret. You will be notified if a secret expires and you can renew it. Check with your company policies — maybe there are restrictions on the duration of secrets.
Click “Add” (4) to add the secret to your registered app.
Save the following information:
- Application (client) ID
- Secret value
Configure SSO
Before proceeding, ensure that you’ve selected the corresponding Flip AI app registration (1) in Azure.
Click on “Authentication” (2) in the navigation panel and click on “Add a platform” (3) to open up a panel on the right side.
Select “Web” (4) as the type of the app platform.
Insert the URI (1) of your Flip AI tenant's endpoint. Your contact at Flip AI will provide this information to you. If you already know the domain and the tenant ID of your Flip AI tenant, you can build the URI yourself: https://DOMAIN/auth/realms/TENANT/broker/oidc-azuread/endpoint
Select the ID token option (2) and save (3) your configuration.
It will now be listed under “Platform configurations”.
Click on “Overview” in the navigation panel and switch to “Endpoints” to get important information for the Syncer configuration.
Save the following information:
- OAuth 2.0 token endpoint (v1!) (1)
- OpenID Connect metadata document (2)
You can close the panel again.
Set up the User Principal Name (UPN)
If you’re planing to use information besides the Unique User Identifier / User Principal Name (UPN) as the username in Flip AI, please get in touch with your contact person at Flip AI. We have to configure a mapping for the specific user information and the username in Flip AI. Otherwise, Flip AI can’t identify the user correctly.
Within your App registration (1), select “Token configuration” (2) in the navigation panel.
Check if “upn” is already listed. If not, click “Add optional claim” (3), select “ID” as the type of token and also “upn” (5) in the list below.
Then save this configuration by clicking on “Add” (6).
Handover to Flip AI
After going through each step, this is the list of information that should be noted down:
- Directory (tenant) ID
- App Registration Application (client) ID
- App Registration Secret Value
- OAuth 2.0 token endpoint
- OpenID Connect metadata document
- User principal name of the Flip AI test user
- Password of the Flip AI test user
Please send all information to your contact person at Flip AI. They will set up Single-Sign-On for you.