title | description | author | manager | ms.service | ms.subservice | ms.topic | ms.date | ms.author | ms.reviewer | ms.custom | zone_pivot_groups |
---|---|---|---|---|---|---|---|---|---|---|---|
Manage users and groups assignment to an application |
Learn how to assign and unassign users, and groups, for an app using Microsoft Entra ID for identity management. |
omondiatieno |
CelesteDG |
entra-id |
enterprise-apps |
how-to |
12/18/2023 |
jomondi |
ergreenl |
enterprise-apps, has-azure-ad-ps-ref |
enterprise-apps-all |
This article shows you how to assign users and groups to an enterprise application in Microsoft Entra ID using PowerShell. When you assign a user to an application, the application appears in the user's My Apps portal for easy access. If the application exposes app roles, you can also assign a specific app role to the user.
When you assign a group to an application, only users in the group have access. The assignment doesn't cascade to nested groups.
Group-based assignment requires Microsoft Entra ID P1 or P2 edition. Group-based assignment is supported for Security groups, Microsoft 365 groups, and Distribution groups whose SecurityEnabled
setting is set to True
only. Nested group memberships aren't currently supported. For more licensing requirements for the features discussed in this article, see the Microsoft Entra pricing page.
For greater control, certain types of enterprise applications can be configured to require user assignment. For more information on requiring user assignment for an app, see Manage access to an application.
To assign users to an enterprise application, you need:
- A Microsoft Entra account with an active subscription. If you don't already have one, you can Create an account for free.
- One of the following roles: Cloud Application Administrator, Application Administrator, or owner of the service principal.
- Microsoft Entra ID P1 or P2 for group-based assignment. For more licensing requirements for the features discussed in this article, see the Microsoft Entra pricing page.
:::zone pivot="portal"
[!INCLUDE portal updates]
To assign a user or group account to an enterprise application:
-
Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
-
Browse to Identity > Applications > Enterprise applications > All applications.
-
Enter the name of the existing application in the search box, and then select the application from the search results.
-
Select Users and groups, and then select Add user/group.
:::image type="content" source="media/add-application-portal-assign-users/assign-user.png" alt-text="Assign user account to an application in your Microsoft Entra tenant.":::
-
On the Add Assignment pane, select None Selected under Users and groups.
-
Search for and select the user or group that you want to assign to the application. For example,
contosouser1@contoso.com
orcontosoteam1@contoso.com
. -
Select Select.
-
Under Select a role, select the role that you want to assign to the user or group. If you haven't defined any roles yet, the default role is Default Access.
-
On the Add Assignment pane, select Assign to assign the user or group to the application.
- Follow the steps on the Assign users, and groups, to an application section to navigate to the Users and groups pane.
- Search for and select the user or group that you want to unassign from the application.
- Select Remove to unassign the user or group from the application.
:::zone-end
:::zone pivot="aad-powershell"
-
Open an elevated Windows PowerShell command prompt.
-
Run
Connect-AzureAD
and sign in as at least a Cloud Application Administrator. -
Use the following script to assign a user and role to an application:
# Assign the values to the variables $username = "<Your user's UPN>" $app_name = "<Your App's display name>" $app_role_name = "<App role display name>" # Get the user to assign, and the service principal for the app to assign to $user = Get-AzureADUser -ObjectId "$username" $sp = Get-AzureADServicePrincipal -Filter "displayName eq '$app_name'" $appRole = $sp.AppRoles | Where-Object { $_.DisplayName -eq $app_role_name } # Assign the user to the app role New-AzureADUserAppRoleAssignment -ObjectId $user.ObjectId -PrincipalId $user.ObjectId -ResourceId $sp.ObjectId -Id $appRole.Id
To assign a group to an enterprise app, you must replace Get-AzureADUser
with Get-AzureADGroup
and replace New-AzureADUserAppRoleAssignment
with New-AzureADGroupAppRoleAssignment
.
For more information about how to assign a group to an application role, see the documentation for New-AzureADGroupAppRoleAssignment.
This example assigns the user Britta Simon to the Microsoft Workplace Analytics application using PowerShell.
-
In PowerShell, assign the corresponding values to the variables $username, $app_name and $app_role_name.
# Assign the values to the variables $username = "britta.simon@contoso.com" $app_name = "Workplace Analytics"
-
In this example, we don't know what is the exact name of the application role we want to assign to Britta Simon. Run the following commands to get the user ($user) and the service principal ($sp) using the user UPN and the service principal display names.
# Get the user to assign, and the service principal for the app to assign to $user = Get-AzureADUser -ObjectId "$username" $sp = Get-AzureADServicePrincipal -Filter "displayName eq '$app_name'"
-
Run the command
$sp.AppRoles
to display the roles available for the Workplace Analytics application. In this example, we want to assign Britta Simon the Analyst (Limited access) Role. -
Assign the role name to the
$app_role_name
variable.# Assign the values to the variables $app_role_name = "Analyst (Limited access)" $appRole = $sp.AppRoles | Where-Object { $_.DisplayName -eq $app_role_name }
-
Run the following command to assign the user to the app role:
# Assign the user to the app role New-AzureADUserAppRoleAssignment -ObjectId $user.ObjectId -PrincipalId $user.ObjectId -ResourceId $sp.ObjectId -Id $appRole.Id
-
Open an elevated Windows PowerShell command prompt.
-
Run
Connect-AzureAD
and sign in as at least a Cloud Application Administrator. -
Use the following script to remove a user and role from an application.
# Store the proper parameters $user = get-azureaduser -ObjectId <objectId> $spo = Get-AzureADServicePrincipal -ObjectId <objectId> #Get the ID of role assignment $assignments = Get-AzureADServiceAppRoleAssignment -ObjectId $spo.ObjectId | Where {$_.PrincipalDisplayName -eq $user.DisplayName} #if you run the following, it will show you what is assigned what $assignments | Select * #To remove the App role assignment run the following command. Remove-AzureADServiceAppRoleAssignment -ObjectId $spo.ObjectId -AppRoleAssignmentId $assignments[assignment number].ObjectId
Use the following script to remove all users and groups assigned to the application.
#Retrieve the service principal object ID.
$app_name = "<Your App's display name>"
$sp = Get-AzureADServicePrincipal -Filter "displayName eq '$app_name'"
$sp.ObjectId
# Get Service Principal using objectId
$sp = Get-AzureADServicePrincipal -ObjectId "<ServicePrincipal objectID>"
# Get Azure AD App role assignments using objectId of the Service Principal
$assignments = Get-AzureADServiceAppRoleAssignment -ObjectId $sp.ObjectId -All $true
# Remove all users and groups assigned to the application
$assignments | ForEach-Object {
if ($_.PrincipalType -eq "User") {
Remove-AzureADUserAppRoleAssignment -ObjectId $_.PrincipalId -AppRoleAssignmentId $_.ObjectId
} elseif ($_.PrincipalType -eq "Group") {
Remove-AzureADGroupAppRoleAssignment -ObjectId $_.PrincipalId -AppRoleAssignmentId $_.ObjectId
}
}
:::zone-end
:::zone pivot="ms-powershell"
- Open an elevated Windows PowerShell command prompt.
- Run
Connect-MgGraph -Scopes "Application.ReadWrite.All", "Directory.ReadWrite.All", "AppRoleAssignment.ReadWrite.All"
and sign in as at least a Cloud Application Administrator. - Use the following script to assign a user and role to an application:
# Assign the values to the variables
$userId = "<Your user's ID>"
$app_name = "<Your App's display name>"
$app_role_name = "<App role display name>"
$sp = Get-MgServicePrincipal -Filter "displayName eq '$app_name'"
# Get the user to assign, and the service principal for the app to assign to
$params = @{
"PrincipalId" =$userId
"ResourceId" =$sp.Id
"AppRoleId" =($sp.AppRoles | Where-Object { $_.DisplayName -eq $app_role_name }).Id
}
# Assign the user to the app role
New-MgUserAppRoleAssignment -UserId $userId -BodyParameter $params |
Format-List Id, AppRoleId, CreationTime, PrincipalDisplayName,
PrincipalId, PrincipalType, ResourceDisplayName, ResourceId
- Open an elevated Windows PowerShell command prompt.
- Run
Connect-MgGraph -Scopes "Application.ReadWrite.All", "Directory.ReadWrite.All", "AppRoleAssignment.ReadWrite.All"
and sign in as at least a Cloud Application Administrator. Use the following script to remove a user and role from an application.
# Get the user and the service principal
$user = Get-MgUser -UserId <userid>
$spo = Get-MgServicePrincipal -ServicePrincipalId <ServicePrincipalId>
# Get the Id of the role assignment
$assignments = Get-MgServicePrincipalAppRoleAssignedTo -ServicePrincipalId $spo.Id | Where {$_.PrincipalDisplayName -eq $user.DisplayName}
# if you run the following, it will show you the list of users assigned to the application
$assignments | Select *
# To remove the App role assignment run the following command.
Remove-MgServicePrincipalAppRoleAssignedTo -AppRoleAssignmentId '<AppRoleAssignment-id>' -ServicePrincipalId $spo.Id
Use the following script to remove all users and groups assigned to the application.
$assignments | ForEach-Object {
if ($_.PrincipalType -in ("user", "Group")) {
Remove-MgServicePrincipalAppRoleAssignedTo -ServicePrincipalId $Sp.Id -AppRoleAssignmentId $_.Id }
}
:::zone-end
:::zone pivot="ms-graph"
-
To assign users and groups to an application, sign in to Graph Exploreras at least a Cloud Application Administrator.
You need to consent to the following permissions:
Application.ReadWrite.All
,Directory.ReadWrite.All
,AppRoleAssignment.ReadWrite.All
.To grant an app role assignment, you need three identifiers:
principalId
: The ID of the user or group to which you're assigning the app role.resourceId
: The ID of the resource servicePrincipal that defines the app role.appRoleId
: The ID of the appRole (defined on the resource service principal) to assign to a user or group.
-
Get the enterprise application. Filter by DisplayName.
GET https://graph.microsoft.com/v1.0/servicePrincipals?$filter=displayName eq '{appDisplayName}'
Record the following values from the response body:
- Object ID of the enterprise application
- appRoleId that you assign to the user. If the application doesn't expose any roles, the user is assigned the default access role.
-
Get the user by filtering by the user's principal name. Record the object ID of the user.
GET https://graph.microsoft.com/v1.0/users/{userPrincipalName}
-
Assign the user to the application.
POST https://graph.microsoft.com/v1.0/servicePrincipals/{resource-servicePrincipal-id}/appRoleAssignedTo { "principalId": "aaaaaaaa-bbbb-cccc-1111-222222222222", "resourceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1", "appRoleId": "00000000-0000-0000-0000-000000000000" }
In the example, both the resource-servicePrincipal-id and resourceId represent the enterprise application.
To unassign user and groups from the application, run the following query.
-
Get the enterprise application. Filter by displayName.
GET https://graph.microsoft.com/v1.0/servicePrincipals?$filter=displayName eq '{appDisplayName}'
-
Get the list of appRoleAssignments for the application.
GET https://graph.microsoft.com/v1.0/servicePrincipals/{id}/appRoleAssignedTo
-
Remove the appRoleAssignments by specifying the appRoleAssignment ID.
DELETE https://graph.microsoft.com/v1.0/servicePrincipals/{resource-servicePrincipal-id}/appRoleAssignedTo/{appRoleAssignment-id}
:::zone-end