Skip to content

Commit 18140c4

Browse files
committed
Merging changes synced from https://github.com/MicrosoftDocs/azure-docs-pr (branch live)
2 parents 6ebde64 + d8b174f commit 18140c4

File tree

383 files changed

+1260
-637
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

383 files changed

+1260
-637
lines changed

articles/active-directory/manage-apps/configure-authentication-for-federated-users-portal.md

Lines changed: 126 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,51 @@
11
---
22
title: Configure sign-in auto-acceleration using Home Realm Discovery
33
titleSuffix: Azure AD
4-
description: Learn how to configure Home Realm Discovery policy for Azure Active Directory authentication for federated users, including auto-acceleration and domain hints.
4+
description: Learn how to force federated IdP acceleration for an application using Home Realm Discovery policy.
55
services: active-directory
6-
author: davidmu1
6+
author: hpsin
77
manager: CelesteDG
88
ms.service: active-directory
99
ms.subservice: app-mgmt
1010
ms.workload: infrastructure-services
1111
ms.topic: how-to
12-
ms.date: 08/13/2021
13-
ms.author: davidmu
14-
ms.custom: seoapril2019
12+
ms.date: 02/09/2022
13+
ms.author: hirsin
14+
ms.custom: seoapril2019, contperf-fy22q2
1515
ms.collection: M365-identity-device-management
16-
ms.reviewer: hirsin
16+
zone_pivot_groups: home-realm-discovery
1717

1818
#customer intent: As and admin, I want to configure Home Realm Discovery for Azure AD authentication for federated users.
1919
---
2020

21-
# Configure sign-in behavior
21+
# Configure sign-in behavior using Home Realm Discovery
2222

23-
This article provides an introduction to configuring Azure Active Directory(Azure AD) authentication behavior for federated users using Home Realm Discovery (HRD) policy. It covers using auto-acceleration to skip the username entry screen and automatically forward users to federated login endpoints. Microsoft does not recommend configuring auto-acceleration any longer, as it can prevent the use of stronger authentication methods such as First Identity Online (FIDO) and hinders collaboration.
23+
This article provides an introduction to configuring Azure Active Directory(Azure AD) authentication behavior for federated users using Home Realm Discovery (HRD) policy. It covers using auto-acceleration to skip the username entry screen and automatically forward users to federated login endpoints. To learn more about HRD policy, see [Home Realm Discovery](home-realm-discovery-policy.md)
24+
25+
For federated users with cloud-enabled credentials, such as SMS sign-in or FIDO keys, you should prevent sign-in auto-acceleration. See [Disable auto-acceleration sign-in](prevent-domain-hints-with-home-realm-discovery.md) to learn how to prevent domain hints with HRD.
2426

2527
## Prerequisites
2628

2729
To configure HRD policy for an application in Azure AD, you need:
2830

29-
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
31+
- An Azure account with an active subscription. If you don't already have one, you can [create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
3032
- One of the following roles: Global Administrator, Cloud Application Administrator, Application Administrator, or owner of the service principal.
33+
::: zone pivot="powershell-hrd"
3134
- The latest Azure AD PowerShell cmdlet preview.
35+
::: zone-end
3236

3337
## Set up an HRD policy on an application
38+
::: zone pivot="powershell-hrd"
3439

3540
We'll use Azure AD PowerShell cmdlets to walk through a few scenarios, including:
3641

42+
::: zone-end
43+
::: zone pivot="graph-hrd"
44+
45+
We'll use Microsoft Graph to walk through a few scenarios, including:
46+
47+
::: zone-end
48+
3749
- Setting up HRD policy to do auto-acceleration for an application in a tenant with a single federated domain.
3850

3951
- Setting up HRD policy to do auto-acceleration for an application to one of several domains that are verified for your tenant.
@@ -42,7 +54,9 @@ We'll use Azure AD PowerShell cmdlets to walk through a few scenarios, including
4254

4355
- Listing the applications for which a policy is configured.
4456

45-
In the following examples, you create, update, link, and delete policies on application service principals in Azure AD.
57+
::: zone pivot="powershell-hrd"
58+
59+
In the following examples, you create, update, link, and delete HRD policies on application service principals in Azure AD.
4660

4761
1. Before you begin, run the Connect command to sign in to Azure AD with your admin account:
4862

@@ -58,27 +72,69 @@ In the following examples, you create, update, link, and delete policies on appl
5872
5973
If nothing is returned, it means you have no policies created in your tenant.
6074
61-
In this example, you create a policy that when it is assigned to an application either:
62-
63-
- Auto-accelerates users to an AD FS sign-in screen when they are signing in to an application when there is a single domain in your tenant.
64-
- Auto-accelerates users to an AD FS sign-in screen if there is more than one federated domain in your tenant.
65-
- Enables non-interactive username/password sign in directly to Azure AD for federated users for the applications the policy is assigned to.
75+
::: zone-end
6676
6777
## Create an HRD policy
6878
69-
The following policy auto-accelerates users to an AD FS sign-in screen when they are signing in to an application when there is a single domain in your tenant.
79+
In this example, you create a policy that when it's assigned to an application either:
80+
81+
- Auto-accelerates users to an federated identity provider sign-in screen when they are signing in to an application when there is a single domain in your tenant.
82+
- Auto-accelerates users to an federated identity provider sign-in screen if there is more than one federated domain in your tenant.
83+
- Enables non-interactive username/password sign-in directly to Azure AD for federated users for the applications the policy is assigned to.
84+
85+
The following policy auto-accelerates users to an federated identity provider sign-in screen when they're signing in to an application when there's a single domain in your tenant.
86+
87+
::: zone pivot="powershell-hrd"
7088
7189
```powershell
7290
New-AzureADPolicy -Definition @("{`"HomeRealmDiscoveryPolicy`":{`"AccelerateToFederatedDomain`":true}}") -DisplayName BasicAutoAccelerationPolicy -Type HomeRealmDiscoveryPolicy
7391
```
92+
::: zone-end
93+
94+
::: zone pivot="graph-hrd"
95+
96+
```json
97+
"HomeRealmDiscoveryPolicy": {
98+
"AccelerateToFederatedDomain": true
99+
}
100+
```
101+
::: zone-end
102+
103+
The following policy auto-accelerates users to an federated identity provider sign-in screen when there is more than one federated domain in your tenant. If you have more than one federated domain that authenticates users for applications, you need to specify the domain to auto-accelerate.
74104

75-
The following policy auto-accelerates users to an AD FS sign-in screen when there is more than one federated domain in your tenant. If you have more than one federated domain that authenticates users for applications, you need specify the domain to auto-accelerate.
105+
::: zone pivot="powershell-hrd"
76106

77107
```powershell
78108
New-AzureADPolicy -Definition @("{`"HomeRealmDiscoveryPolicy`":{`"AccelerateToFederatedDomain`":true, `"PreferredDomain`":`"federated.example.edu`"}}") -DisplayName MultiDomainAutoAccelerationPolicy -Type HomeRealmDiscoveryPolicy
79109
```
110+
::: zone-end
80111

81-
To create a policy to enable username/password authentication for federated users directly with Azure AD for specific applications, run the following command:
112+
::: zone pivot="graph-hrd"
113+
114+
```json
115+
"HomeRealmDiscoveryPolicy": {
116+
"AccelerateToFederatedDomain": true
117+
"PreferredDomain": ["federated.example.edu"]
118+
}
119+
```
120+
::: zone-end
121+
122+
The following policy enables username/password authentication for federated users directly with Azure AD for specific applications:
123+
124+
125+
::: zone pivot="graph-hrd"
126+
127+
```json
128+
129+
"EnableDirectAuthPolicy": {
130+
"AllowCloudPasswordValidation": true
131+
}
132+
133+
```
134+
135+
::: zone-end
136+
137+
::: zone pivot="powershell-hrd"
82138

83139
```powershell
84140
New-AzureADPolicy -Definition @("{`"HomeRealmDiscoveryPolicy`":{`"AllowCloudPasswordValidation`":true}}") -DisplayName EnableDirectAuthPolicy -Type HomeRealmDiscoveryPolicy
@@ -114,32 +170,32 @@ Add-AzureADServicePrincipalPolicy -Id <ObjectID of the Service Principal> -RefOb
114170

115171
You can repeat this command for each service principal to which you want to add the policy.
116172

117-
In the case where an application already has a HomeRealmDiscovery policy assigned, you won't be able to add a second one. In that case, change the definition of the Home Realm Discovery policy that is assigned to the application to add additional parameters.
173+
In the case where an application already has a HomeRealmDiscovery policy assigned, you won't be able to add a second one. In that case, change the definition of the HRD policy that is assigned to the application to add extra parameters.
118174

119175
### Check which application service principals your HRD policy is assigned to
120176

121177
To check which applications have HRD policy configured, use the **Get-AzureADPolicyAppliedObject** cmdlet. Pass it the **ObjectID** of the policy that you want to check on.
122178

123179
```powershell
124180
Get-AzureADPolicyAppliedObject -id <ObjectId of the Policy>
125-
181+
```
126182
Try the application to check that the new policy is working.
127183

128184
### List the applications for which HRD policy is configured
129185

130186
1. List all policies that were created in your organization
131187

132-
```powershell
133-
Get-AzureADPolicy
134-
```
188+
```powershell
189+
Get-AzureADPolicy
190+
```
135191
136192
Note the **ObjectID** of the policy that you want to list assignments for.
137193
138194
2. List the service principals to which the policy is assigned
139195
140-
```powershell
141-
Get-AzureADPolicyAppliedObject -id <ObjectId of the Policy>
142-
```
196+
```powershell
197+
Get-AzureADPolicyAppliedObject -id <ObjectId of the Policy>
198+
```
143199
144200
## Remove an HRD policy from an application
145201
@@ -149,16 +205,53 @@ Use the previous example to get the **ObjectID** of the policy, and that of the
149205
150206
2. Remove the policy assignment from the application service principal
151207
152-
```powershell
153-
Remove-AzureADServicePrincipalPolicy -id <ObjectId of the Service Principal> -PolicyId <ObjectId of the policy>
154-
```
208+
```powershell
209+
Remove-AzureADServicePrincipalPolicy -id <ObjectId of the Service Principal> -PolicyId <ObjectId of the policy>
210+
```
155211
156212
3. Check removal by listing the service principals to which the policy is assigned
157213
158-
```powershell
159-
Get-AzureADPolicyAppliedObject -id <ObjectId of the Policy>
160-
```
214+
```powershell
215+
Get-AzureADPolicyAppliedObject -id <ObjectId of the Policy>
216+
```
217+
::: zone-end
218+
::: zone pivot="graph-hrd"
219+
220+
## Configuring policy through Graph Explorer
221+
222+
Set the HRD policy using Microsoft Graph. See [homeRealmDiscoveryPolicy](https://docs.microsoft.com/graph/api/resources/homeRealmDiscoveryPolicy?view=graph-rest-1.0) resource type for information on how to create the policy.
223+
224+
From the Microsoft Graph explorer window:
225+
226+
1. Grant the Policy.ReadWrite.ApplicationConfiguration permission under the **Modify permissions** tab.
227+
1. Use the URL https://graph.microsoft.com/v1.0/policies/homeRealmDiscoveryPolicies
228+
1. POST the new policy to this URL, or PATCH to /policies/homerealmdiscoveryPolicies/{policyID} if overwriting an existing one.
229+
1. POST or PATCH contents:
230+
231+
```json
232+
{
233+
"definition": [
234+
"{\"HomeRealmDiscoveryPolicy\":
235+
{\"AccelerateToFederatedDomain\":true,
236+
\"PreferredDomain\":\"federated.example.edu\",
237+
\"AlternateIdLogin\":{\"Enabled\":true}}}"
238+
],
239+
"displayName": "Home Realm Discovery auto acceleration",
240+
"isOrganizationDefault": true
241+
}
242+
```
243+
1. To see your new policy and get its ObjectID, run the following query:
244+
245+
```http
246+
GET policies/homeRealmDiscoveryPolicies
247+
```
248+
1. To delete the HRD policy you created, run the query:
249+
250+
```http
251+
DELETE /policies/homeRealmDiscoveryPolicies/{policy objectID}
252+
```
253+
::: zone-end
161254
162255
## Next steps
163256
164-
- For more information about how Home Realm Discovery works in Azure AD, see [Home Realm Discovery for an application in Azure AD](home-realm-discovery-policy.md).
257+
[Prevent sign-in auto-acceleration](prevent-domain-hints-with-home-realm-discovery.md).

0 commit comments

Comments
 (0)