List scopedMembers for a directory role
Namespace: microsoft.graph
Retrieve a list of scopedRoleMembership objects for a directory role.
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.Read.Directory | Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | RoleManagement.Read.Directory | Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory |
HTTP request
You can address the directory role using either its id or roleTemplateId.
GET /directoryroles/{role-id}/scopedMembers
GET /directoryRoles(roleTemplateId='{roleTemplateId}')/scopedMembers
Optional query parameters
This method supports the OData query parameters to help customize the response.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a collection of scopedRoleMembership objects in the response body.
Examples
Example 1: Get the members of a directory role using role id
Request
The following example shows a request for a directory role id 43a63cc2-582b-4d81-a79d-1591f91d5558
.
GET https://graph.microsoft.com/v1.0/directoryRoles/43a63cc2-582b-4d81-a79d-1591f91d5558/scopedMembers
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#scopedRoleMemberships",
"value": [
{
"id": "LyrRQajKPk66FAXlECzghXFuYtw3SOtAvkq8KdiKEXiTwZeOU-r8RIHrq2vQ4F1wU",
"roleId": "43a63cc2-582b-4d81-a79d-1591f91d5558",
"administrativeUnitId": "dc626e71-4837-40eb-be4a-bc29d88a1178",
"roleMemberInfo": {
"id": "8e97c193-ea53-44fc-81eb-ab6bd0e05d70",
"displayName": "Adele Vance"
}
}
]
}
Example 2: Get the scoped members of a directory role using roleTemplateId
Request
The following example shows a request for a directory role with roleTemplateId fdd7a751-b60b-444a-984c-02652fe8fa1c
.
GET https://graph.microsoft.com/v1.0/directoryRoles(roleTemplateId='fdd7a751-b60b-444a-984c-02652fe8fa1c')/scopedMembers
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#scopedRoleMemberships",
"value": [
{
"id": "LyrRQajKPk66FAXlECzghXFuYtw3SOtAvkq8KdiKEXiTwZeOU-r8RIHrq2vQ4F1wU",
"roleId": "41d12a2f-caa8-4e3e-ba14-05e5102ce085",
"administrativeUnitId": "dc626e71-4837-40eb-be4a-bc29d88a1178",
"roleMemberInfo": {
"id": "8e97c193-ea53-44fc-81eb-ab6bd0e05d70",
"displayName": "Adele Vance"
}
}
]
}