-
Notifications
You must be signed in to change notification settings - Fork 582
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6746 from MicrosoftDocs/main
01/30/2025 PM Publishing
- Loading branch information
Showing
12 changed files
with
94 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
--- | ||
title: Register a SAML app | ||
description: Learn how to create and register a SAML app with External ID for customer identity and access management (CIAM). Choose your app type and get detailed steps. | ||
author: msmimart | ||
ms.author: mimart | ||
manager: CelesteDG | ||
ms.service: entra-external-id | ||
ms.subservice: external | ||
ms.topic: how-to | ||
ms.date: 01/29/2025 | ||
ms.custom: it-pro | ||
|
||
#Customer intent: As a dev, devops, or it admin, I want to learn about how to register a SAML app through the Microsoft Entra admin center. | ||
--- | ||
# Register a SAML app in your external tenant (preview) | ||
|
||
[!INCLUDE [applies-to-external-only](../includes/applies-to-external-only.md)] | ||
|
||
In external tenants, you can register applications that use the OpenID Connect (OIDC) or Security Assertion Markup Language (SAML) protocol for authentication and single sign-on. The [app registration](how-to-register-ciam-app.md) process is designed specifically for OIDC apps. But you can use the Enterprise applications feature to create and register your SAML app. This process generates a unique application ID (client ID) and adds your app to the App registrations, where you can view and manage its properties. | ||
|
||
This article describes how to register your own SAML application in your external tenant by creating a *non-gallery* app in **Enterprise applications**. | ||
|
||
> [!NOTE] | ||
> The following capabilities aren't supported for SAML apps in external tenants: | ||
>- Preintegrated SAML applications in the Microsoft Entra gallery aren't supported in external tenants. | ||
>- The availability of the **Provisioning** tab in the SAML app settings is a known issue. Provisioning isn't supported for apps in external tenants. | ||
>- IdP initiated flow isn't supported. | ||
## Prerequisites | ||
|
||
- An Azure account that has an active subscription. <a href="https://azure.microsoft.com/free/?WT.mc_id=A261C142F" target="_blank">Create an account for free</a>. | ||
- A Microsoft Entra [external tenant](how-to-create-external-tenant-portal.md). | ||
- [A sign-up and sign-in user flow](how-to-user-flow-sign-up-sign-in-customers.md). | ||
|
||
## Create and register a SAML app | ||
|
||
1. Sign in to the Microsoft Entra admin center as at least an Application Administrator. | ||
1. If you have access to multiple tenants, use the **Settings** icon :::image type="icon" source="media/common/admin-center-settings-icon.png" border="false"::: in the top menu and switch to your external tenant from the **Directories** menu. | ||
1. Go to **Identity** > **Applications** > **Enterprise Applications (Preview)**. | ||
1. Select **New application**. | ||
|
||
1. Select **Create your own application**. | ||
|
||
:::image type="content" source="media/how-to-register-saml-app/create-your-own-application.png" alt-text="Screenshot of the Create your own application option in the Microsoft Entra Gallery."::: | ||
|
||
1. On the **Create your own application** pane, enter a name for your app. | ||
|
||
> [!NOTE] | ||
> You might see a gallery app selector, but you can disregard it as gallery apps aren't supported in external tenants. | ||
1. Select "**(Preview) Integrate any other application you don't find in the gallery (Non-gallery)**". | ||
|
||
1. Select **Create**. | ||
|
||
1. The app **Overview** page opens. In the left menu under **Manage**, select **Properties**. Switch the **Assignment required?** toggle to **No** so that users can use self-service sign-up, and then select **Save**. | ||
|
||
:::image type="content" source="media/how-to-register-saml-app/assignment-toggle-no.png" alt-text="Screenshot of the Assignment required toggle."::: | ||
|
||
1. In the left menu under **Manage**, select **Single sign-on (Preview)**. | ||
1. Under **Select a single sign-on method**, select **SAML (preview)**. | ||
|
||
:::image type="content" source="media/how-to-register-saml-app/select-single-sign-on-method.png" alt-text="Screenshot of the Single sign-on method tile."::: | ||
|
||
1. On the **SAML-based Sign-on (Preview)** page, do one of the following: | ||
|
||
- Select **Upload metadata file**, browse to the file containing your metadata, and then select **Add**. Select **Save**. | ||
- Or, use the **Edit** pencil option to update each section, and then select **Save**. | ||
|
||
> [!NOTE] | ||
> Make sure your SAML app uses your `ciamlogin` endpoint, for example `domainname.ciamlogin.com`, instead of `login.microsoft.com`. If you're downloading the federation metadata URL, it should be in the form `domain.ciamlogin.com/<tenantid>/federationmetadata/2007-06/federationmetadata.xml?appid=<appid>`. | ||
1. Select **Test**, and then select the **Test sign-in** button to see if single sign-on is working. This test verifies that your current admin account can sign in using the `https://login.microsoftonline.com` endpoint. | ||
|
||
:::image type="content" source="media/how-to-register-saml-app/test-application.png" alt-text="Screenshot of the test single sign-on option."::: | ||
|
||
You can test external user sign-in with these steps: | ||
- [Create a sign-up and sign-in user flow](~/external-id/customers/how-to-user-flow-sign-up-sign-in-customers.md) if you haven't already. | ||
- [Add your SAML application to the user flow](~/external-id/customers/how-to-user-flow-add-application.md). | ||
- Run your application. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+3.79 KB
docs/external-id/customers/media/how-to-register-saml-app/assignment-toggle-no.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+19 KB
...nal-id/customers/media/how-to-register-saml-app/create-your-own-application.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+62.1 KB
...al-id/customers/media/how-to-register-saml-app/select-single-sign-on-method.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+8.71 KB
docs/external-id/customers/media/how-to-register-saml-app/test-application.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file modified
BIN
-17.8 KB
(94%)
.../media/troubleshoot-mac-sso-extension-plugin/sso-extension-column-structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.