Skip to content

Commit 5ebbf7f

Browse files
committed
Fix table formatting
1 parent 2213c9f commit 5ebbf7f

File tree

1 file changed

+27
-34
lines changed

1 file changed

+27
-34
lines changed

articles/active-directory/hybrid/how-to-connect-fed-group-claims.md

Lines changed: 27 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ Azure Active Directory can provide a users group membership information in token
3030
3131
## Group claims for applications migrating from AD FS and other identity providers
3232

33-
Many applications that are configured to authenticate with AD FS rely on group membership information in the form of Windows AD group attributes. These attributes are the group sAMAccountName, which may be qualified by-domain name, or the Windows Group Security Identifier (GroupSID). When the application is federated with AD FS, AD FS uses the TokenGroups function to retrieve the group memberships for the user.
33+
Many applications configured to authenticate with AD FS rely on group membership information in the form of Windows AD group attributes. These attributes are the group sAMAccountName, which may be qualified by-domain name, or the Windows Group Security Identifier (GroupSID). When the application is federated with AD FS, AD FS uses the TokenGroups function to retrieve the group memberships for the user.
3434

35-
To match the token an app would receive from AD FS, group and role claims may be emitted containing the domain qualified sAMAccountName rather than the group's Azure Active Directory objectID.
35+
An app that has been moved from AD FS needs claims in the same format. Group and role claims may be emitted from Azure Active Directory containing the domain qualified sAMAccountName or the GroupSID synced from Active Directory rather than the group's Azure Active Directory objectID.
3636

3737
The supported formats for group claims are:
3838

@@ -47,33 +47,33 @@ The supported formats for group claims are:
4747
4848
## Options for applications to consume group information
4949

50-
One way for applications to obtain group information is to call the Graph groups endpoint in order to retrieve the group membership for the authenticated user. This call ensures that all the groups a user is a member of are available even when there are a large number of groups involved and the application needs to enumerate all groups the user is a member of. Group enumeration is then independent of token size limitations.
50+
Applications can call the MS Graph groups endpoint to obtain group information for the authenticated user. This call ensures that all the groups a user is a member of are available even when there are a large number of groups involved. Group enumeration is then independent of token size limitations.
5151

52-
However, if an existing application already expects to consume group information via claims in the token it receives, Azure Active Directory can be configured with a number of different claims options to fit the needs of the application. Consider the following options:
52+
However, if an existing application expects to consume group information via claims, Azure Active Directory can be configured with a number of different claims formats. Consider the following options:
5353

54-
- When using group membership for in-application authorization purposes it’s preferable to use the Group ObjectID, which is immutable and unique in Azure Active Directory and available for all groups.
55-
- If using the on-premises group sAMAccountName for authorization, use domain qualified names; there’s less chance of situations arising were names clash. sAMAccountName on its own may be unique within an Active Directory domain, but if more than one Active Directory domain is synchronized with an Azure Active Directory tenant there is a possibility for more than one group to have the same name.
54+
- When using group membership for in-application authorization purposes it is preferable to use the Group ObjectID. The Group ObjectID is immutable and unique in Azure Active Directory and available for all groups.
55+
- If using the on-premises group sAMAccountName for authorization, use domain qualified names; there’s less chance of names clashing. sAMAccountName may be unique within an Active Directory domain, but if more than one Active Directory domain is synchronized with an Azure Active Directory tenant there is a possibility for more than one group to have the same name.
5656
- Consider using [Application Roles](../../active-directory/develop/howto-add-app-roles-in-azure-ad-apps.md) to provide a layer of indirection between the group membership and the application. The application then makes internal authorization decisions based on role clams in the token.
57-
- If the application is configured to get group attributes that are synced from Active Directory and a Group doesn't contain those attributes it won't be included in the claims.
58-
- Group claims in tokens include nested groups except when usign the option to restrict group claims to those assigned to the application. If a user is a member of GroupB and GroupB is a member of GroupA, then the group claims for the user will contain both GroupA and GroupB. For organizations with heavy usage of nested groups and users with large numbers of group memberships the number of groups listed in the token can grow the token size. Azure Active Directory limits the number of groups it will emit in a token to 150 for SAML assertions, and 200 for JWT to prevent tokens getting too large. If a user is a member of a larger number of groups than the limit, the groups are emitted along with a link to the Graph endpoint to obtain group information.
57+
- If the application is configured to get group attributes that are synced from Active Directory and a Group doesn't contain those attributes, it won't be included in the claims.
58+
- Group claims in tokens include nested groups except when using the option to restrict the group claims to groups assigned to the application. If a user is a member of GroupB and GroupB is a member of GroupA, then the group claims for the user will contain both GroupA and GroupB. When an organization's users have large numbers of group memberships, the number of groups listed in the token can grow the token size. Azure Active Directory limits the number of groups it will emit in a token to 150 for SAML assertions, and 200 for JWT. If a user is a member of a larger number of groups, the groups are omitted and a link to the Graph endpoint to obtain group information is included instead.
5959

60-
## Prerequisites for using Group attributes synchronized from Active Directory
60+
## Prerequisites for using Group attributes synchronized from Active Directory
6161

62-
Group membership claims can be emitted in tokens for any group if you use the ObjectId format. To use group claims in formats other then the group ObjectId, the groups must be synchronized from Active Directory using Azure AD Connect.
62+
Group membership claims can be emitted in tokens for any group if you use the ObjectId format. To use group claims in formats other than the group ObjectId, the groups must be synchronized from Active Directory using Azure AD Connect.
6363

6464
There are two steps to configuring Azure Active Directory to emit group names for Active Directory Groups.
6565

6666
1. **Synchronize group names from Active Directory**
67-
Before Azure Active Directory can emit the group names or on premises group SID in group or role claims, the required attributes need to be synchronized from Active Directory. You must be running Azure AD Connect version 1.2.70 or later. Prior to version 1.2.70 Azure AD Connect will synchronize the group objects from Active Directory, but doesn’t include the required group name attributes by default. You should upgrade to the current version.
67+
Before Azure Active Directory can emit the group names or on premises group SID in group or role claims, the required attributes need to be synchronized from Active Directory. You must be running Azure AD Connect version 1.2.70 or later. Earlier versions of Azure AD Connect than 1.2.70 will synchronize the group objects from Active Directory, but will not include the required group name attributes. Upgrade to the current version.
6868

6969
2. **Configure the application registration in Azure Active Directory to include group claims in tokens**
70-
Group claims can be configured either in the Enterprise Applications section of the portal for a Gallery or Non-Gallery SAML SSO application, or using the Application Manifest in the Application Registrations section. To configure group claims in the application manifest see “Configuring the Azure Active Directory Application Registration for group attributes” below.
70+
Group claims can be configured in the Enterprise Applications section of the portal, or using the Application Manifest in the Application Registrations section. To configure group claims in the application manifest see “Configuring the Azure Active Directory Application Registration for group attributes” below.
7171

7272
## Add group claims to tokens for SAML applications using SSO configuration
7373

74-
To configure Group Claims for a Gallery or Non-Gallery SAML application, open Enterprise Applications, click on the application in the list and select Single Sign On configuration, and then select User Attributes & claims.
74+
To configure Group Claims for a Gallery or Non-Gallery SAML application, open **Enterprise Applications**, click on the application in the list, select **Single Sign On configuration**, and then select **User Attributes & Claims**.
7575

76-
Select the edit icon next to "User attributes & Claims"
76+
Click on **Add a group claim**
7777

7878
![claims UI](media/how-to-connect-fed-group-claims/group-claims-ui-1.png)
7979

@@ -83,28 +83,26 @@ Use the radio buttons to select which groups should be included in the token
8383

8484
| Selection | Description |
8585
|----------|-------------|
86-
| **All groups** | Emits security groups and distribution lists. It also causes Directory Roles the user is assigned to be emitted in a 'wids' claim, and any application roles the user is assigned to be emitted in the roles claim. |
86+
| **All groups** | Emits security groups and distribution lists and roles. |
8787
| **Security groups** | Emits security groups the user is a member of in the groups claim |
88-
| **Directory roles** | If the user is assigned directory roles they are emitted as a 'wids' claim (groups claim won't be emitted) |
89-
| **Groups assigned to the application** | Emits only the groups which are explicitly assigned to the application and the user is a member of |
88+
| **Directory roles** | If the user is assigned directory roles, they are emitted as a 'wids' claim (groups claim won't be emitted) |
89+
| **Groups assigned to the application** | Emits only the groups that are explicitly assigned to the application and the user is a member of |
9090

9191
For example, to emit all the Security Groups the user is a member of, select Security Groups
9292

9393
![claims UI](media/how-to-connect-fed-group-claims/group-claims-ui-3.png)
9494

95-
To emit groups using Active Directory attributes synced from Active Directory instead of Azure AD objectIDs select the required format from the drop-down. This replaces the object ID in the claims with string values containing group names. Only groups synchronized from Active Directory will be included in the claims.
95+
To emit groups using Active Directory attributes synced from Active Directory instead of Azure AD objectIDs select the required format from the drop-down. Only groups synchronized from Active Directory will be included in the claims.
9696

9797
![claims UI](media/how-to-connect-fed-group-claims/group-claims-ui-4.png)
9898

9999
To emit only groups assigned to the application, select **Groups Assigned to the application**
100100

101101
![claims UI](media/how-to-connect-fed-group-claims/group-claims-ui-4-1.png)
102102

103-
Only groups assigned to the application will be included in the token. Other groups the user is a member of will be omitted. With this option nested groups are not included. The user must be a direct member of the group assigned to the application.
103+
Groups assigned to the application will be included in the token. Other groups the user is a member of will be omitted. With this option nested groups are not included and the user must be a direct member of the group assigned to the application.
104104

105-
To see, or change the groups assigned to the application, from the Enterprise Applications list, select the application and then click **Users and Groups** from the application’s left hand navigation menu.
106-
107-
![claims UI](media/how-to-connect-fed-group-claims/group-claims-ui-4-2.png)
105+
To change the groups assigned to the application, select the application from the **Enterprise Applications** list and then click **Users and Groups** from the application’s left-hand navigation menu.
108106

109107
See the document [Methods for assigning users and groups to an app](../../active-directory/manage-apps/methods-for-assigning-users-and-groups#assign-groups) for details of managing group assignment to applications.
110108

@@ -125,7 +123,7 @@ Some applications require the group membership information to appear in the 'rol
125123
126124
### Edit the group claims configuration
127125

128-
Once a group claim configuration has been added to the User Attributes & Claims configuration under Additional claims, the option to add a group claim will be greyed out. To change the group claim configuration click on the group claim in the **Additional claims** list.
126+
Once a group claim configuration has been added to the User Attributes & Claims configuration, the option to add a group claim will be greyed out. To change the group claim configuration click on the group claim in the **Additional claims** list.
129127

130128
![claims UI](media/how-to-connect-fed-group-claims/group-claims-ui-7.png)
131129

@@ -137,19 +135,14 @@ Group claims can also be configured in the [Optional Claims](../../active-direct
137135

138136
2. Enable group membership claims by changing the groupMembershipClaim
139137

140-
The valid values are:
141-
142-
- "All"
143-
- "SecurityGroup"
144-
- "DirectoryRole"
145-
- "ApplicationGroup"
138+
Valid values are:
146139

147-
| Selection | Description |
140+
| Selection | Description |
148141
|----------|-------------|
149-
| **"All"** | Emits security groups and distribution lists. It also causes Directory Roles the user is assigned to be emitted in a 'wids' claim, and any application roles the user is assigned to be emitted in the roles claim. |
142+
| **"All"** | Emits security groups, distribution lists and roles |
150143
| **"SecurityGroup"** | Emits security groups the user is a member of in the groups claim |
151-
| **"DirectoryRole** | If the user is assigned directory roles they are emitted as a 'wids' claim (groups claim won't be emitted) |
152-
| **"ApplicationGroup** | Emits only the groups which are explicitly assigned to the application and the user is a member of |
144+
| **"DirectoryRole** | If the user is assigned directory roles, they are emitted as a 'wids' claim (groups claim won't be emitted) |
145+
| **"ApplicationGroup** | Emits only the groups that are explicitly assigned to the application and the user is a member of |
153146

154147
For example:
155148

@@ -161,7 +154,7 @@ Group claims can also be configured in the [Optional Claims](../../active-direct
161154

162155
3. Set group name configuration optional claims.
163156

164-
If you want the groups in the token to contain the on premises AD group attributes in the optional claims section specify which token type optional claim should be applied to, the name of optional claim requested and any additional properties desired. Multiple token types can be listed:
157+
If you want the groups in the token to contain the on premises AD group attributes, specify which token type optional claim should be applied to in the optional claims section. Multiple token types can be listed:
165158

166159
- idToken for the OIDC ID token
167160
- accessToken for the OAuth/OIDC access token

0 commit comments

Comments
 (0)