Skip to content

Latest commit

 

History

History
79 lines (65 loc) · 3.61 KB

permission_facet.md

File metadata and controls

79 lines (65 loc) · 3.61 KB
Raw

Permission object

Represents a permission on a OneDrive item.

Permissions in OneDrive have a number of different forms. The Permission object represents these different forms through facets on the Permission object.

JSON representation

{
  "id": "string",
  "roles": ["read|write"],
  "link": { "@odata.type": "oneDrive.sharingLink" },
  "inheritedFrom": { "@odata.type": "oneDrive.itemReference" }
}

Properties

Property name Type Description
id string Read Only The unique identifier of the permission among all permissions on the item.
role Array of strings The type of permission, e.g. read. See below for the full list of roles.
link SharingLink Read Only Provides the link details of the current permission, if it is a link type permissions.
inheritedFrom ItemReference Read Only Provides a reference to the ancestor of the current permission, if it is inherited from an ancestor.

Roles enumeration

Role Details
read Provides the ability to read the metadata and contents of the item.
write Provides the ability to read and modify the metadata and contents of the item.

Sharing links

The most common type of permissions in OneDrive are sharing links. Sharing links provide a unique URL that includes both the resource being shared and an authentication token that provides access to the resource. Users don't need to sign-in to access the content shared with a sharing link. Users can share a link that gives read-only access to the content, or writable access to the content.

View Link

A view link provides read-only access to an item.

{
  "id": "1",
  "roles": ["read"],
  "link": {
    "type": "view",
    "webUrl": "https://onedrive.live.com/redir?resid=5D33DD65C6932946!70859&authkey=!AL7N1QAfSWcjNU8&ithint=folder%2cgif",
    "application": { "id": "1234", "displayName": "Sample Application" }
  }
}

Edit link

An edit link provides read and write access to an item.

{
  "id": "2",
  "roles": ["write"],
  "link": {
    "type": "write",
    "webUrl": "https://onedrive.live.com/redir?resid=5D33DD65C6932946!70859&authkey=!AL7N1QAfSWcjNU8&ithint=folder%2cgif",
    "application": { "id": "1234", "displayName": "Sample Application" }
  }
}