List appConsentRequests

Namespace: microsoft.graph

Retrieve appConsentRequest objects and their properties.

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) ConsentRequest.Read.All, ConsentRequest.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application ConsentRequest.Read.All, ConsentRequest.ReadWrite.All

HTTP request

GET /identityGovernance/appConsent/appConsentRequests

Optional query parameters

This method supports the $select, $skip, $top, $filter (eq), and $orderby OData query parameters to help customize the response. You can also apply $filter (eq) on the collection of objects in theuserConsentRequests relationship. For general information, see OData query parameters.

Request headers

Name Description
Authorization 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 a collection of appConsentRequest objects in the response body.

Examples

Example 1: List all appConsentRequests

Request

GET https://graph.microsoft.com/v1.0/identityGovernance/appConsent/appConsentRequests

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#identityGovernance/appConsent/appConsentRequests",
    "@odata.count": 1,
    "value": [
        {
            "id": "7322e5f3-0f15-4eb8-9e82-2029e8622f5d",
            "appId": "de8bc8b5-d9f9-48b1-a8ad-b748da725064",
            "appDisplayName": "Graph Explorer",
            "pendingScopes": [
                {
                    "displayName": "AccessReview.Read.All"
                },
                {
                    "displayName": "openid"
                },
                {
                    "displayName": "profile"
                },
                {
                    "displayName": "offline_access"
                }
            ],
            "userConsentRequests@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/appConsent/appConsentRequests('7322e5f3-0f15-4eb8-9e82-2029e8622f5d')/userConsentRequests",
            "userConsentRequests": []
        }
    ]
}

Example 2: List all appConsentRequests with at least one userConsentRequest whose status is InProgress

Request

GET https://graph.microsoft.com/v1.0/identityGovernance/appConsent/appConsentRequests?$filter=userConsentRequests/any (u:u/status eq 'InProgress')

Response

The following is an example of the response. The response object includes all appConsentRequest objects that have at least one userConsentRequest that's InProgress, but doesn't expand the related userConsentRequests relationship.

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#identityGovernance/appConsent/appConsentRequests",
    "@odata.count": 1,
    "value": [
        {
            "id": "7322e5f3-0f15-4eb8-9e82-2029e8622f5d",
            "appId": "de8bc8b5-d9f9-48b1-a8ad-b748da725064",
            "appDisplayName": "Graph Explorer",
            "consentType": "Dynamic",
            "pendingScopes": [
                {
                    "displayName": "AccessReview.Read.All"
                },
                {
                    "displayName": "openid"
                },
                {
                    "displayName": "profile"
                },
                {
                    "displayName": "offline_access"
                }
            ],
            "userConsentRequests@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/appConsent/appConsentRequests('7322e5f3-0f15-4eb8-9e82-2029e8622f5d')/userConsentRequests",
            "userConsentRequests": []
        }
    ]
}