List members of a directory role
Namespace: microsoft.graph
Retrieve the list of principals that are assigned to the directory role.
You can use both the object ID and template ID of the directoryRole with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Azure portal. For details, see Role template IDs.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
When an application queries a relationship that returns a directoryObject type collection, if it does not have permission to read a certain derived type (like device), members of that type are returned but with limited information. With this behaviour applications can request the least privileged permissions they need, rather than rely on the set of Directory.* permissions. For details, see Limited information returned for inaccessible member objects.
HTTP request
You can address the directory role using either its id or roleTemplateId.
GET /directoryRoles/{role-id}/members
GET /directoryRoles(roleTemplateId='{roleTemplateId}')/members
Optional query parameters
This method supports the OData query parameters to help customize the response.
Request headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and collection of directoryObject objects in the response body.
Examples
Example 1: Get the members of a directory role using role id
Request
GET https://graph.microsoft.com/v1.0/directoryRoles/43a63cc2-582b-4d81-a79d-1591f91d5558/members
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"businessPhones":["000-000-0000"],
"displayName":"Adele Vance",
"givenName":"Adele",
"jobTitle":null,
"mail":"AdeleV@contoso.com",
"officeLocation":null,
"preferredLanguage":"en-US",
"surname":"Vance",
"userPrincipalName":"AdeleV@contoso.com"
}
]
}
Example 2: Get the members of a directory role using roleTemplateId
Request
GET https://graph.microsoft.com/v1.0/directoryRoles(roleTemplateId='43a63cc2-582b-4d81-a79d-1591f91d5558')/members
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"businessPhones":["000-000-0000"],
"displayName":"Adele Vance",
"givenName":"Adele",
"jobTitle":null,
"mail":"AdeleV@contoso.com",
"officeLocation":null,
"preferredLanguage":"en-US",
"surname":"Vance",
"userPrincipalName":"AdeleV@contoso.com"
}
]
}
Feedback
Submit and view feedback for