Using role-based access control for applications

Applies to: Workforce tenants External tenants (learn more)

Role-based access control (RBAC) is a popular mechanism to enforce authorization in applications. When an organization uses RBAC, an application developer defines roles for the application. An administrator can then assign roles to different users and groups to control who has access to content and functionality in the application.

Applications typically receive user role information as claims in a security token. Developers have the flexibility to provide their own implementation for how role claims are to be interpreted as application permissions. This interpretation of permissions can involve using middleware or other options provided by the platform of the applications or related libraries.

App roles

Microsoft Entra External ID allows you to define application roles for your application and assign those roles to users and groups. The roles you assign to a user or group define their level of access to the resources and operations in your application.

When Microsoft Entra External ID issues a security token for an authenticated user, it includes the names of the roles you've assigned the user or group in the security token's roles claim. An application that receives that security token in a request can then make authorization decisions based on the values in the roles claim.

To try out this feature, go to the Woodgrove Groceries demo and start the “Role-based access control” use case.

Groups

Developers can also use security groups to implement RBAC in their applications, where the memberships of the user in specific groups are interpreted as their role memberships. When an organization uses security groups, a groups claim is included in the token. The groups claim specifies the identifiers of all of the groups to which the user is assigned within the current external tenant.

To try out this feature, go to the Woodgrove Groceries demo and start the “Group-based access control” use case.

App roles vs. groups

Though you can use app roles or groups for authorization, key differences between them can influence which you decide to use for your scenario.

Create a security group

Security groups manage user and computer access to shared resources. You can create a security group so that all group members have the same set of security permissions.

To create a security group, follow these steps:

1. Sign in to the Microsoft Entra admin center as at least an Application Developer.
2. If you have access to multiple tenants, use the Settings icon in the top menu to switch to your external tenant from the Directories + subscriptions menu.
3. Browse to Identity >Groups >All groups.
4. Select New group.
5. Under Group type dropdown, select Security.
6. Enter Group name for the security group, such as Contoso_App_Administrators.
7. Enter Group description for the security group, such as Contoso app Security Administrator.
8. Select Create.

The new security group appears in the All groups list. If you don't see it immediately, refresh the page.

Microsoft Entra External ID can include a user's group membership information in tokens for use within applications. You learn how to add the group claim to tokens in Assign users and groups to roles section.

Declare roles for an application

1. Sign in to the Microsoft Entra admin center as at least an Application Administrator.
2. If you have access to multiple tenants, use the Settings icon in the top menu to switch to your external tenant from the Directories + subscriptions menu.
3. Browse to Identity >Applications >App registrations.
4. Select the application you want to define app roles in.
5. Select App roles, and then select Create app role.
6. In the Create app role pane, enter the settings for the role. The following table describes each setting and its parameters.

Assign users and groups to roles

Once you've added app roles in your application, administrator can assign users and groups to the roles. Assignment of users and groups to roles can be done through the admin center, or programmatically using Microsoft Graph. When the users assigned to the various app roles sign in to the application, their tokens have their assigned roles in the roles claim.

To assign users and groups to application roles by using the Azure portal:

1. Sign in to the Microsoft Entra admin center as at least an Application Administrator
2. If you have access to multiple tenants, use the Settings icon in the top menu to switch to your external tenant from the Directories + subscriptions menu.
3. Browse to Identity >Applications >Enterprise applications.
4. Select All applications to view a list of all your applications. If your application doesn't appear in the list, use the filters at the top of the All applications list to restrict the list, or scroll down the list to locate your application.
5. Select the application in which you want to assign users or security group to roles.
6. Under Manage, select Users and groups.
7. Select Add user to open the Add Assignment pane.
8. In the Add Assignment pane, select Users and groups. A list of users and security groups appears. You can select multiple users and groups in the list.
9. Once you've selected users and groups, choose Select.
10. In the Add assignment pane, choose Select a role. All the roles you defined for the application appear.
11. Select a role, and then choose Select.
12. Select Assign to finish the assignment of users and groups to the app.
13. Confirm that the users and groups you added appear in the Users and groups list.

To test your application, sign out and sign in again with the user you assigned the roles. Inspect the security token to make sure that it contains the user's role.

Add group claims to security tokens

To emit the group membership claims in security tokens, follow these steps:

1. Sign in to the Microsoft Entra admin center as at least an Application Administrator.
2. If you have access to multiple tenants, use the Settings icon in the top menu to switch to your external tenant from the Directories + subscriptions menu.
3. Browse to Identity >Applications >App registrations.
4. Select the application in which you want to add the groups claim.
5. Under Manage, select Token configuration.
6. Select Add groups claim.
7. Select group types to include in the security tokens.
8. For the Customize token properties by type, select Group ID.
9. Select Add to add the groups claim.

Add members to a group

Now that you've added app groups claim in your application, add users to the security groups. If you don't have security group, create one.

1. Sign in to the Microsoft Entra admin center as at least a Groups Administrator.
2. If you have access to multiple tenants, use the Settings icon in the top menu to switch to your external tenant from the Directories + subscriptions menu.
3. Browse to Identity >Groups >All groups.
4. Select the group you want to manage.
5. Select Members.
6. Select + Add members.
7. Scroll through the list or enter a name in the search box. You can choose multiple names. When you're ready, choose Select.
8. The Group Overview page updates to show the number of members who are now added to the group.

To test your application, sign out, and then sign in again with the user you added to the security group. Inspect the security token to make sure that it contains the user's group membership.

Groups and application roles support

An external tenant follows the Microsoft Entra user and group management model and application assignment. Many of the core Microsoft Entra features are being phased into external tenants.

The following table shows which features are currently available.

Next steps

• Learn how to Use role-based access control in your web application.