Edit

Share via

plannerPlan: getUsageRights

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 the usage rights for a specific plan based on its sensitivity label assignment and the requesting user permissions. This method returns information about whether the plan has a sensitivity label applied and which specific actions (view, edit, print, copy, and export) the user is allowed to perform on the plan content, based on Rights Management Services (RMS) evaluation.

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) Tasks.Read Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

HTTP request

GET /planner/plans/{plannerPlanId}/getUsageRights

Optional query parameters

This method doesn't support OData query parameters to customize the response. For general information, see OData query parameters.

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 function returns a 200 OK response code and a planUsageRight in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/planner/plans/xqQg5FS2LkCp935s-FIFm2QAFkHM/getUsageRights

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.type": "microsoft.graph.planUsageRight",
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "hasSensitivityLabel": true,
  "usageRights": {
    "@odata.type": "microsoft.graph.usageRightsInfo",
    "allowView": true,
    "allowEdit": true,
    "allowPrint": true,
    "allowCopy": true,
    "allowExport": true
  }
}
  • Last updated on