Namespace: microsoft.graph
Assign a Microsoft Entra role with administrative unit scope. For a list of roles that can be assigned with administrative unit scope, see Assign Microsoft Entra roles with administrative unit scope.
This API is available in the following national cloud deployments.
Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
✅ |
✅ |
✅ |
✅ |
Permissions
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) |
RoleManagement.ReadWrite.Directory |
Not available. |
Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
Application |
RoleManagement.ReadWrite.Directory |
Not available. |
Important
In delegated scenarios with work or school accounts, the signed-in user must be a member user or be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Privileged Role Administrator is the least privileged role supported for this operation.
HTTP request
POST /directory/administrativeUnits/{id}/scopedRoleMembers
Request body
In the request body, supply a JSON representation of scopedRoleMembership object.
Response
If successful, this method returns 201 Created
response code and scopedRoleMembership object in the response body.
Example
Request
The following example shows a request.
POST https://graph.microsoft.com/v1.0/directory/administrativeUnits/{id}/scopedRoleMembers
Content-type: application/json
{
"roleId": "roleId-value",
"roleMemberInfo": {
"id": "id-value"
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new ScopedRoleMembership
{
RoleId = "roleId-value",
RoleMemberInfo = new Identity
{
Id = "id-value",
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.AdministrativeUnits["{administrativeUnit-id}"].ScopedRoleMembers.PostAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
mgc directory administrative-units scoped-role-members create --administrative-unit-id {administrativeUnit-id} --body '{\
"roleId": "roleId-value",\
"roleMemberInfo": {\
"id": "id-value"\
}\
}\
'
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewScopedRoleMembership()
roleId := "roleId-value"
requestBody.SetRoleId(&roleId)
roleMemberInfo := graphmodels.NewIdentity()
id := "id-value"
roleMemberInfo.SetId(&id)
requestBody.SetRoleMemberInfo(roleMemberInfo)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
scopedRoleMembers, err := graphClient.Directory().AdministrativeUnits().ByAdministrativeUnitId("administrativeUnit-id").ScopedRoleMembers().Post(context.Background(), requestBody, nil)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
ScopedRoleMembership scopedRoleMembership = new ScopedRoleMembership();
scopedRoleMembership.setRoleId("roleId-value");
Identity roleMemberInfo = new Identity();
roleMemberInfo.setId("id-value");
scopedRoleMembership.setRoleMemberInfo(roleMemberInfo);
ScopedRoleMembership result = graphClient.directory().administrativeUnits().byAdministrativeUnitId("{administrativeUnit-id}").scopedRoleMembers().post(scopedRoleMembership);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
const options = {
authProvider,
};
const client = Client.init(options);
const scopedRoleMembership = {
roleId: 'roleId-value',
roleMemberInfo: {
id: 'id-value'
}
};
await client.api('/directory/administrativeUnits/{id}/scopedRoleMembers')
.post(scopedRoleMembership);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ScopedRoleMembership;
use Microsoft\Graph\Generated\Models\Identity;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ScopedRoleMembership();
$requestBody->setRoleId('roleId-value');
$roleMemberInfo = new Identity();
$roleMemberInfo->setId('id-value');
$requestBody->setRoleMemberInfo($roleMemberInfo);
$result = $graphServiceClient->directory()->administrativeUnits()->byAdministrativeUnitId('administrativeUnit-id')->scopedRoleMembers()->post($requestBody)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Import-Module Microsoft.Graph.Identity.DirectoryManagement
$params = @{
roleId = "roleId-value"
roleMemberInfo = @{
id = "id-value"
}
}
New-MgDirectoryAdministrativeUnitScopedRoleMember -AdministrativeUnitId $administrativeUnitId -BodyParameter $params
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.scoped_role_membership import ScopedRoleMembership
from msgraph.generated.models.identity import Identity
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ScopedRoleMembership(
role_id = "roleId-value",
role_member_info = Identity(
id = "id-value",
),
)
result = await graph_client.directory.administrative_units.by_administrative_unit_id('administrativeUnit-id').scoped_role_members.post(request_body)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
In the request body, supply a JSON representation of scopedRoleMembership object.
Response
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/v1.0/$metadata#scopedRoleMemberships/$entity",
"administrativeUnitId": "administrativeUnitId-value",
"roleId": "roleId-value",
"roleMemberInfo": {
"id": "id-value",
"displayName": "displayName-value",
"userPrincipalName": "userPrincipalName-value"
},
"id": "id-value"
}