Edit

Share via

userProtectionScopeContainer: compute

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.

Compute the data protection policies and actions applicable to a specific user based on their context.

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 permission Higher privileged permissions
Delegated (work or school account) ProtectionScopes.Compute.User ProtectionScopes.Compute.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application ProtectionScopes.Compute.All Not available.

HTTP request

POST /me/dataSecurityAndGovernance/protectionScopes/compute

Note

Calling the /me endpoint requires a signed-in user and therefore a delegated permission. Application permissions aren't supported when using the /me endpoint.

POST /users/{usersId}/dataSecurityAndGovernance/protectionScopes/compute

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.
If-None-Match Optional. This value is used by the API to determine if the policy state has changed since the last call to the API.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
activities microsoft.graph.security.userActivityTypes Optional. Flags specifying the user activities the calling application supports or is interested. Possible values are none, uploadText, uploadFile, downloadText, downloadFile, unknownFutureValue. This object is a multi-valued enumeration.
deviceMetadata deviceMetadata Optional. Information about the user's device (type, OS) used for contextual policy evaluation.
integratedAppMetadata integratedApplicationMetadata Optional. Information about the calling application (name, version) integrating with Microsoft Purview.
locations policyLocation collection Optional. List of specific locations the application is interested in. If provided, results are trimmed to policies covering these locations. Use policy ___location application for application locations, policy ___location ___domain for ___domain locations, or policy ___location URL for URL locations. You must specify the @odata.type property to declare the type of policyLocation. For example, "@odata.type": "microsoft.graph.policyLocationApplication".
pivotOn microsoft.graph.policyPivotProperty Optional. Specifies how the results should be aggregated. If omitted or none, results might be less aggregated. Possible values are activity,___location, none.

Response headers

Name Description
ETag An indicator whether the admin-configured policy state has changed. If the Etag matches the If-None-Match value and you have cached the results of parsing previous results from this API, there is no need to parse the response and cache the parsed results. Cache this value for calls to process content.

Response

If successful, this action returns a 200 OK response code and a collection of policyUserScope objects in the response body. Each object represents a set of locations and activities governed by a common set of policy actions and execution mode for the specified user.

Examples

Request

The following example computes the protection scope for a user performing text uploads, interested in a specific ___domain, pivoting the results by activity.

POST https://graph.microsoft.com/beta/users/7c1f8f10-cba8-4a8d-9449-db4b876d1ef70/dataSecurityAndGovernance/protectionScopes/compute
Content-type: application/json

{
   "activities": "uploadText,downloadText",
   "locations": [
      {
         "@odata.type": "microsoft.graph.policyLocationApplication",
         "value": "83ef208a-0396-4893-9d4f-d36efbffc8bd"
      }
   ]
}

Response

The following example shows the response. It indicates that for the uploadText activity to public.contoso.com, policies require inline evaluation and trigger a browserRestriction action (likely blocking uploads based on sensitive content).

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#Collection(microsoft.graph.policyUserScope)",
  "value": [
    {
      "activities": "uploadText,downloadText",
      "executionMode": "evaluateOffline",
      "locations": [
        {
          "value": "83ef208a-0396-4893-9d4f-d36efbffc8bd"
        }
      ],
      "policyActions": []
    },
    {
      "activities": "uploadText",
      "executionMode": "evaluateInline",
      "locations": [
        {
          "value": "83ef208a-0396-4893-9d4f-d36efbffc8bd"
        }
      ],
      "policyActions": []
    }
  ]
}