oauth2permissiongrant: delta

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 newly created, updated, or deleted oauth2permissiongrant objects without performing a full read of the entire resource collection. For details, see Using delta query.

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

HTTP request

To begin tracking changes, you make a request including the delta function on the oauth2permissiongrant resource.

GET /oauth2PermissionGrants/delta

Query parameters

Tracking changes incurs a round of one or more delta function calls. If you use any query parameter (other than $deltatoken and $skiptoken), you must specify it in the initial delta request. Microsoft Graph automatically encodes any specified parameters into the token portion of the @odata.nextLink or @odata.deltaLink URL provided in the response. You only need to specify any query parameters once up front. In subsequent requests, copy and apply the @odata.nextLink or @odata.deltaLink URL from the previous response. That URL already includes the encoded parameters.

Query parameter Type Description
$deltatoken string A state token returned in the @odata.deltaLink URL of the previous delta function call for the same resource collection, indicating the completion of that round of change tracking. Save and apply the entire @odata.deltaLink URL, including this token, in the first request of the next round of change tracking for that collection.
$skiptoken string A state token returned in the @odata.nextLink URL of the previous delta function call, indicating that there are further changes to be tracked in the same resource collection.

Optional query parameters

This method supports OData query parameters to help customize the response.

  • You can use a $select query parameter as in any GET request to specify only the properties your need for best performance. The id property is always returned.
  • There is limited support for $filter:
    • The only supported $filter expression is for tracking changes for specific resources, by their ID: $filter=id+eq+{value} or $filter=id+eq+{value1}+or+id+eq+{value2}. The number of IDs you can specify is limited by the maximum URL length.

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 an oauth2permissiongrant collection object in the response body. The response also includes a @odata.nextLink URL or a @odata.deltaLink URL.

  • If a @odata.nextLink URL is returned, there are additional pages of data to be retrieved in the session. The oauth2permissiongrant continues making requests using the @odata.nextLink URL until a @odata.deltaLink URL is included in the response.
  • If a @odata.deltaLink URL is returned, there is no more data about the existing state of the resource to be returned. Persist and use the @odata.deltaLink URL to learn about changes to the resource in the future.

For details, see Using delta query. For example requests, see Get incremental changes for users.

Example

Request

GET https://graph.microsoft.com/beta/oauth2PermissionGrants/delta

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#oauth2permissiongrants",
  "@odata.nextLink":"https://graph.microsoft.com/beta/oauth2permissiongrants/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
  "value": [
    {
      "clientId": "22a3c970-8ad4-4120-8127-300837f87f2c",
      "consentType": "Principal",
      "expiryTime": "2017-08-13T21:41:23.3929007Z",
      "principalId": "c2e8df37-c6a7-4d88-89b1-feb4f1fda7c5",
      "resourceId": "98dc9d95-49b6-405a-b3c0-834e969a708b",
      "scope": "User.Read Directory.AccessAsUser.All",
      "startTime": "0001-01-01T00:00:00Z",
      "id": "cMmjItSKIEGBJzAIN_h_LJWd3Ji2SVpAs8CDTpaacIs33-jCp8aITYmx_rTx_afF"
    }
  ]
}