List customAppScopes
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.
Get a list of customAppScope objects for an RBAC provider.
Currently only the Exchange Online RBAC provider is supported.
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.Exchange | RoleManagement.Read.All, RoleManagement.ReadWrite.Exchange |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | RoleManagement.Read.Exchange | RoleManagement.Read.All, RoleManagement.ReadWrite.Exchange |
HTTP request
For an Exchange Online provider:
GET /roleManagement/exchange/customAppScopes
Optional query parameters
This method supports the $filter
and $count
OData query parameters to help customize the response. Note that $filter
doesn't work for nested properties stored in the customAttributes property.
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 customAppScope objects in the response body.
Examples
Request
The following example shows how to request all customAppScope objects of an Exchange Online provider.
GET https://graph.microsoft.com/beta/roleManagement/exchange/customAppScopes
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/beta/$metadata#roleManagement/exchange/customAppScopes",
"value": [
{
"id": "a6a7ef59-ff39-46b1-ae6b-2d9c4d6380cd",
"type": "RecipientScope",
"displayName": "scope 1",
"customAttributes": {
"Exclusive": false,
"RecipientFilter": "City -eq 'Seattle'"
}
},
{
"id": "0b708633-b2ea-4673-b630-18922c345560",
"type": "RecipientScope",
"displayName": "scope 2",
"customAttributes": {
"Exclusive": false,
"RecipientFilter": "ExternalDirectoryObjectId -eq '45ad6645-57a8-4fef-ad2f-ac5bd3de7d7c'"
}
}
]
}