Grant an appRoleAssignment to a service principal
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Assign an app role to a client service principal.
App roles that are assigned to service principals are also known as application permissions. Application permissions can be granted directly with app role assignments, or through a consent experience.
To grant an app role assignment to a client service principal, you need three identifiers:
principalId
: Theid
of the client service principal to which you are assigning the app role.resourceId
: Theid
of the resourceservicePrincipal
(the API) which has defined the app role (the application permission).appRoleId
: Theid
of theappRole
(defined on the resource service principal) to assign to the client service principal.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | AppRoleAssignment.ReadWrite.All and Application.Read.All | AppRoleAssignment.ReadWrite.All and Directory.Read.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | AppRoleAssignment.ReadWrite.All and Application.Read.All | AppRoleAssignment.ReadWrite.All and Directory.Read.All |
Important
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation:
- Directory Synchronization Accounts - for Microsoft Entra Connect and Microsoft Entra Cloud Sync services
- Directory Writer
- Hybrid Identity Administrator
- Identity Governance Administrator
- Privileged Role Administrator
- User Administrator
- Application Administrator
- Cloud Application Administrator
You can address the service principal using either its id or appId. id and appId are referred to as the Object ID and Application (Client) ID, respectively, in app registrations in the Microsoft Entra admin center.
POST /servicePrincipals/{id}/appRoleAssignments
POST /servicePrincipals(appId='{appId}')/appRoleAssignments
Note
As a best practice, we recommend creating app role assignments through the appRoleAssignedTo
relationship of the resource service principal, instead of the appRoleAssignments
relationship of the assigned user, group, or service principal.
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-type | application/json. Required. |
In the request body, supply a JSON representation of an appRoleAssignment object.
If successful, this method returns a 201 Created
response code and an appRoleAssignment object in the response body.
The following example shows a request.
POST https://graph.microsoft.com/beta/servicePrincipals/9028d19c-26a9-4809-8e3f-20ff73e2d75e/appRoleAssignments
Content-Type: application/json
{
"principalId": "9028d19c-26a9-4809-8e3f-20ff73e2d75e",
"resourceId": "8fce32da-1246-437b-99cd-76d1d4677bd5",
"appRoleId": "498476ce-e0fe-48b0-b801-37ba7e2685c6"
}
In this example, note that the value used as the service principal id in the request URL (9028d19c-26a9-4809-8e3f-20ff73e2d75e
) is the same as the principalId property in the body. The resourceId value is the id of the resource service principal (the API).
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#appRoleAssignments/$entity",
"id": "2jLOj0YSe0OZzXbR1Gd71fDqFUrPM1xIgUfvWBHJ9n0",
"creationTimestamp": "2021-02-15T16:39:38.2975029Z",
"appRoleId": "498476ce-e0fe-48b0-b801-37ba7e2685c6",
"principalDisplayName": "Fabrikam App",
"principalId": "9028d19c-26a9-4809-8e3f-20ff73e2d75e",
"principalType": "ServicePrincipal",
"resourceDisplayName": "Microsoft Graph",
"resourceId": "8fce32da-1246-437b-99cd-76d1d4677bd5"
}