Microsoft Provider
- Ryan Seymour
- Vrushali
You can connect an Identity Provider (IdP) like Microsoft Azure AD to your instance.
It is recommended to create a new application in the Azure portal for V4 application login.
Overview
ConnectSecure supports the following providers.
Getting Started
If a user already exists in Zitadel and is linked to Microsoft SSO, they may still be prompted for Zitadel TOTP MFA when logging in via the ConnectSecure portal. To address this, there are two methods available:
Disable Force MFA in Zitadel Settings: Disabling Force MFA in Zitadel settings will prevent the prompt for TOTP MFA. However, please note that after disabling this setting, normal local users will not be prompted for TOTP MFA either.
Remove the user from Zitadel and Reconfigure with SSO: Another approach is to remove the user from Zitadel and then configure them again with SSO. By doing so, the user should no longer be prompted for Zitadel TOTP MFA during login.
To set up an Authentication Provider, log in at https://authprod.myconnectsecure.com and complete these steps:
Click on the Settings header at the top
Click on the Identity Providers section on the left
Tap on the tile of the provider
Providers
Each provider has unique values and integration requirements. Please check out the setup guide for the individual provider(s) as required.
Microsoft
Microsoft Azure AD Configuration
Register a new client
Browse the app registration menus and create a dialog to create a new app.
Give the application a name and choose who can log in (Single-Tenant, Multi-Tenant, Personal Accounts, etc.). This setting will also impact how the provider is configured later on in ZITADEL.
Choose "Web" in the redirect URI field and add the URL:
Example redirect URL for the domain:
https://authprod.myconnectsecure.com/ui/login/login/externalidp/callback
Save the Application (client) ID and the Directory (tenant) ID from the detail page separately as these need to be copied into the ConnectSecure portal.
Add client secret
Generate a new client secret to authenticate your user.
Click on client credentials on the detail page of the application or use the menu "Certificates & secrets"
Click on "+ New client secret," and enter a description and an expiry date, add the secret afterward
Copy the value of the secret. You will not be able to see the value again after some time
Token configuration
To allow ZITADEL to get the information from the authenticating user, you have to configure what kind of optional claims should be returned in the token.
Click on Token configuration in the side menu
Click on "+ Add optional claim"
Add email, family_name, given_name and preferred_username to the id token
API permissions
To be able to get all the information that ZITADEL needs, you have to configure the correct permissions.
Go to "API permissions" in the side menu
Ensure the permissions include "Microsoft Graph": email, profile, and User. Read
The "Other permissions granted" should include "Microsoft Graph: openid"
To Add an Identity Provider in Your ConnectSecure Instance.
Login to the ConnectSecure portal and Click on Profile.
Click on the Company Logo.
Navigate to the Settings.
Modify your login policy in the menu Login Behavior and Security.
Enable the attribute External IDP allowed.
Go to the Identity Providers Overview
Go to the Settings page of your instance or organization and choose "Identity Providers."”
In the table, you can see all the providers you have configured. Also, you will see all provider templates that are available to be configured.
Select the Microsoft Provider template.
Create a new Azure AD Provider
The Microsoft template has everything you need preconfigured. You only have to add the client ID and secret you created in the previous step.
You can configure the following settings if you like; a useful default will be filled if you don't change anything:
Scopes: The scopes define which scopes will be sent to the provider, openid, profile, and email are prefilled. This information will be taken to create/update the user within ZITADEL. Make sure to also add User.Read. ZITADEL ensures that at least openid and User.Read scopes are always sent.
Email Verified: Azure AD doesn't send the email verified claim in the users token, if you don't enable this setting. The user is then created with an unverified email, which results in an email verification message. If you want to avoid that, make sure to enable "Email verified". In that case, the user is created with a verified email address.
Tenant Type: Configure the tenant type according to what you have chosen in the settings of your Azure AD application previously.
Common: Choose common if you want all Microsoft accounts being able to login. In this case, configure "Accounts in any organizational directory and personal Microsoft accounts" in your Azure AD App.
Organizations: Choose organization if you have Azure AD Tenants and no personal accounts. (You have configured either "Accounts in this organization" or "Accounts in any organizational directory" on your Azure APP)
Consumers: Choose this if you want to allow public accounts. (In your Azure AD App you have configured "Personal Microsoft accounts only")
Tenant ID: If you have selected Tenant ID as Tenant Type, you have to enter the Directory (Tenant) ID into the Tenant ID field, copied previously from the Azure App configuration.
Automatic creation: If this setting is enabled the user will be created automatically within ZITADEL, if it doesn't exist.
Automatic update: If this setting is enabled, the user will be updated within ZITADEL, if some user data is changed within the provider. E.g if the lastname changes on the Microsoft account, the information will be changed on the ZITADEL account on the next login.
Account creation allowed: This setting determines if account creation within ZITADEL is allowed or not.
Account linking allowed: This setting determines if account linking is allowed. When logging in with a Microsoft account, a linkable ZITADEL account has to exist already.
Once the details are filled in and options are selected, click on Create.
Under the Identity Provider table, select the created record and Click on set as available.
This completes setting up and adding Microsoft Azure AD Provider.
ConnectSecure portal login using Microsoft
Login to the ConnectSecure Portal and enter the Tenant Name.
Click on Use External Authentication to log in to the portal.
Provide all the fields (Give Name, FamilyName, Username, E.mail, Phone number, Language) and click on Register to create a user in the ConnectSecure portal.
You will receive a verification code at your given email.
Enter the verification code and click on Next to login to ConnectSecure portal.
Once the email address has been Successfully verified and The user will created with NO ROLE assigned to it. Admin should assign the Role as per the requirement.
The Admin user can assign the role to IDP so the user can login and access the ConnectSecure portal.
This completes the Microsoft Authentication Provider Setup.
Get Support
If you have an integration-related inquiry, please email support@connectsecure.com with the details, and our Support Team will assist you.