Skip to content

Commit 85a2995

Browse files
Merge pull request #250089 from omondiatieno/howto-saml
SAML token encryption - Update portal steps
2 parents 3043732 + 08ab693 commit 85a2995

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

articles/active-directory/manage-apps/howto-saml-token-encryption.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,18 @@ To configure token encryption, you need to upload an X.509 certificate file that
3030

3131
Azure AD uses AES-256 to encrypt the SAML assertion data.
3232

33+
## Prerequisites
34+
35+
To configure SAML token encryption, you need:
36+
37+
- An Azure AD user account. If you don't already have one, you can [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
38+
- One of the following roles: Global Administrator, Cloud Application Administrator, Application Administrator, or owner of the service principal.
39+
3340
[!INCLUDE [portal updates](../includes/portal-update.md)]
3441

3542
## Configure enterprise application SAML token encryption
3643

37-
This section describes how to configure enterprise application's SAML token encryption. Applications that have been set up from the **Enterprise applications** blade in the Azure portal, either from the Application Gallery or a Non-Gallery app. For applications registered through the **App registrations** experience, follow the [Configure registered application SAML token encryption](#configure-registered-application-saml-token-encryption) guidance.
44+
This section describes how to configure enterprise application's SAML token encryption. Applications that have been set up from the **Enterprise applications** blade in the Microsoft Entra admin center, either from the Application Gallery or a Non-Gallery app. For applications registered through the **App registrations** experience, follow the [Configure registered application SAML token encryption](#configure-registered-application-saml-token-encryption) guidance.
3845

3946
To configure enterprise application's SAML token encryption, follow these steps:
4047

@@ -48,59 +55,55 @@ To configure enterprise application's SAML token encryption, follow these steps:
4855

4956
1. Add the certificate to the application configuration in Azure AD.
5057

51-
### To configure token encryption in the Azure portal
52-
53-
You can add the public cert to your application configuration within the Azure portal.
58+
### Configure token encryption in the Microsoft Entra admin center
5459

55-
1. Sign in to the [Azure portal](https://portal.azure.com).
56-
57-
1. Search for and select the **Azure Active Directory**.
58-
59-
1. Select **Enterprise applications** blade and then select the application that you wish to configure token encryption for.
60+
You can add the public cert to your application configuration within the Microsoft Entra admin center.
6061

62+
1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com) as at least a [Cloud Application Administrator](../roles/permissions-reference.md#cloud-application-administrator).
63+
1. Browse to **Identity** > **Applications** > **Enterprise applications** > **All applications**.
64+
1. Enter the name of the existing application in the search box, and then select the application from the search results.
6165
1. On the application's page, select **Token encryption**.
6266

63-
![Screenshot shows how to select the Token encryption option in the Azure portal.](./media/howto-saml-token-encryption/token-encryption-option-small.png)
67+
![Screenshot shows how to select the Token encryption option in the Microsoft Entra admin center.](./media/howto-saml-token-encryption/token-encryption-option-small.png)
6468

6569
> [!NOTE]
66-
> The **Token encryption** option is only available for SAML applications that have been set up from the **Enterprise applications** blade in the Azure portal, either from the Application Gallery or a Non-Gallery app. For other applications, this menu option is disabled.
70+
> The **Token encryption** option is only available for SAML applications that have been set up from the **Enterprise applications** blade in the Microsoft Entra admin center, either from the Application Gallery or a Non-Gallery app. For other applications, this menu option is disabled.
6771
6872
1. On the **Token encryption** page, select **Import Certificate** to import the .cer file that contains your public X.509 certificate.
6973

70-
![Screenshot shows how to import a certificate file using Azure portal.](./media/howto-saml-token-encryption/import-certificate-small.png)
74+
![Screenshot shows how to import a certificate file using Microsoft Entra admin center.](./media/howto-saml-token-encryption/import-certificate-small.png)
7175

7276
1. Once the certificate is imported, and the private key is configured for use on the application side, activate encryption by selecting the **...** next to the thumbprint status, and then select **Activate token encryption** from the options in the dropdown menu.
7377

7478
1. Select **Yes** to confirm activation of the token encryption certificate.
7579

7680
1. Confirm that the SAML assertions emitted for the application are encrypted.
7781

78-
### To deactivate token encryption in the Azure portal
82+
### To deactivate token encryption in the Microsoft Entra admin center
7983

80-
1. In the Azure portal, go to **Azure Active Directory > Enterprise applications**, and then select the application that has SAML token encryption enabled.
84+
1. In the Microsoft Entra admin center, go to **Identity** > **Applications** > **Enterprise applications** > **All applications**, and then select the application that has SAML token encryption enabled.
8185

8286
1. On the application's page, select **Token encryption**, find the certificate, and then select the **...** option to show the dropdown menu.
8387

8488
1. Select **Deactivate token encryption**.
8589

8690
## Configure registered application SAML token encryption
8791

88-
This section describes how to configure registered application's SAML token encryption. Applications that have been set up from the **App registrations** blade in the Azure portal. For enterprise application, follow the [Configure enterprise application SAML token encryption](#configure-enterprise-application-saml-token-encryption) guidance.
92+
This section describes how to configure registered application's SAML token encryption. Applications that have been set up from the **App registrations** blade in the Microsoft Entra admin center. For enterprise application, follow the [Configure enterprise application SAML token encryption](#configure-enterprise-application-saml-token-encryption) guidance.
8993

9094
Encryption certificates are stored on the application object in Azure AD with an `encrypt` usage tag. You can configure multiple encryption certificates and the one that's active for encrypting tokens is identified by the `tokenEncryptionKeyID` attribute.
9195

92-
You'll need the application's object ID to configure token encryption using Microsoft Graph API or PowerShell. You can find this value programmatically, or by going to the application's **Properties** page in the Azure portal and noting the **Object ID** value.
96+
You'll need the application's object ID to configure token encryption using Microsoft Graph API or PowerShell. You can find this value programmatically, or by going to the application's **Properties** page in the Microsoft Entra admin center and noting the **Object ID** value.
9397

9498
When you configure a keyCredential using Graph, PowerShell, or in the application manifest, you should generate a GUID to use for the keyId.
9599

96-
To configure token encryption, follow these steps:
100+
To configure token encryption for an application registration, follow these steps:
97101

98102
# [Portal](#tab/azure-portal)
99103

100-
1. From the Azure portal, go to **Azure Active Directory > App registrations**.
101-
102-
1. Select the **All apps** tab to show all apps, and then select the application that you want to configure.
103-
104+
1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com) as at least a [Cloud Application Administrator](../roles/permissions-reference.md#cloud-application-administrator).
105+
1. Browse to **Identity** > **Applications** > **App registrations** > **All applications**.
106+
1. Enter the name of the existing application in the search box, and then select the application from the search results.
104107
1. In the application's page, select **Manifest** to edit the [application manifest](../develop/reference-app-manifest.md).
105108

106109
The following example shows an application manifest configured with two encryption certificates, and with the second selected as the active one using the tokenEncryptionKeyId.
@@ -174,7 +177,7 @@ To configure token encryption, follow these steps:
174177

175178
# [Azure AD PowerShell](#tab/azuread-powershell)
176179

177-
1. Use the latest Azure AD PowerShell module to connect to your tenant.
180+
1. Use the latest Azure AD PowerShell module to connect to your tenant. You need to sign in as at least a [Cloud Application Administrator](../roles/permissions-reference.md#cloud-application-administrator).
178181

179182
1. Set the token encryption settings using the **[Set-AzureApplication](/powershell/module/azuread/set-azureadapplication?view=azureadps-2.0-preview&preserve-view=true)** command.
180183

@@ -192,7 +195,7 @@ To configure token encryption, follow these steps:
192195

193196
# [Microsoft Graph PowerShell](#tab/msgraph-powershell)
194197

195-
1. Use the Microsoft Graph PowerShell module to connect to your tenant.
198+
1. Use the Microsoft Graph PowerShell module to connect to your tenant. You need to sign in as at least a [Cloud Application Administrator](../roles/permissions-reference.md#cloud-application-administrator).
196199

197200
1. Set the token encryption settings using the **[Update-MgApplication](/powershell/module/microsoft.graph.applications/update-mgapplication?view=graph-powershell-1.0&preserve-view=true)** command.
198201

0 commit comments

Comments
 (0)