Documentation Index

Fetch the complete documentation index at: https://support.appgate.com/llms.txt

Use this file to discover all available pages before exploring further.

Integrate Azure AD with ZTP using SAML

Prev Next

Prerequisites

This integration requires the following:

  • An Azure Active Directory (AD) instance on the Microsoft Azure public cloud

  • An active ZTP account, accessible using the Bootstrap Identity provided by AppGate

  • A test user account on your Azure directory with at least the following attributes configured:

    • username, for example: testuser

    • firstName, for example: Joe

    • lastName, for example: Smith

NOTE

Attribute changes may take time to propagate. For details about creating a user account, refer to the Azure Documentation.

Step 1: Add a new application in Azure

  1. Sign in to the Azure portal using your Azure Active Directory administrator account.

  2. In the left menu, go to Microsoft Entra ID > Enterprise Applications.

  3. Click New application, then click Create your own application.

  1. Enter a name, for example: AppGate ZTP.

  2. Under What are you looking to do with your application?, select Non-gallery.

  3. Click Create.

NOTE

For additional details about creating an enterprise application, refer to the Azure Documentation.

Step 2: Configure the application

  1. Return to Microsoft Entra ID > Enterprise Applications and select the application you created.

  2. Under the Getting Started section, select Set up single sign on, or click Single sign-on in the left menu.

  1. Select SAML.

Step 3: Complete basic SAML configuration

  1. In the Identifier (Entity ID) field, enter the Audience value from your ZTP configuration. For this example, use azure-idp.

  2. In the Reply URL (Assertion Consumer Service URL) field, enter a placeholder URL, for example: https://example.com. You will replace this value after completing the configuration.

  1. Click Save.

Step 4: Download the federation metadata

In the SAML Certificates section, download the Federation Metadata XML file. You will upload this file when completing the configuration form.

Step 5: Review attributes and claims

Azure AD requires full URLs for attribute mapping. The following table shows the default claim URLs that Azure AD provides and the corresponding ZTP attribute fields:

Azure AD value

Claim name URL

ZTP field

user.mail

Full claim URL from Azure

Email attribute

user.givenname

Full claim URL from Azure

First name attribute

user.surname

Full claim URL from Azure

Last name attribute

user.userprincipalname

Full claim URL from Azure

Username attribute

Record the claim name URLs displayed in the Azure Attributes & Claims section. You will need them to complete the configuration form.

Step 6: Configure the IdP in ZTP

  1. In ZTP, go to Settings > Identity Providers in the left menu.

  2. Click Add New and select SAML provider.

  3. Complete the form using the following values::

Field

Description

Name*

AZURE – SAML

Audience*

azure-idp

XML Metadata File

Federation metadata XML file downloaded from Azure in Step 4.

SSO URL*

If you uploaded the XML file, this field populates automatically.

Issuer*

If you uploaded the XML file, this field populates automatically.

Public Certificate

If you uploaded the XML file, this field populates automatically.

Email Attribute*

Claim name URL corresponding to user.mail in Azure.

First Name Attribute*

Claim name URL corresponding to user.givenname in Azure.

Last Name Attribute*

Claim name URL corresponding to user.surname in Azure.

Username Attribute*

Claim name URL corresponding to user.userprincipalname in Azure.

  1. Copy the ACS URL from the ZTP form by clicking the copy to clipboard button:

  1. In Azure, return to the Basic SAML Configuration section and replace the placeholder URL (https://example.com) in the Reply URL (Assertion Consumer Service URL) field with the ACS URL you copied.

  2. Click Save and test the integration.