permission リソースの種類Permission resource type

permission リソースは、DriveItem リソースに付与された共有アクセス許可についての情報を提供します。The Permission resource provides information about a sharing permission granted for a DriveItem resource.

共有アクセス許可にはさまざまなフォームがあります。Sharing permissions have a number of different forms. permission リソースは、これらの異なるフォームをリソースのファセットを通じて表します。The Permission resource represents these different forms through facets on the resource.

JSON 表記JSON representation

以下は、リソースの JSON 表記ですHere is a JSON representation of the resource

{
  "id": "string (identifier)",
  "grantedTo": {"@odata.type": "microsoft.graph.identitySet"},
  "inheritedFrom": {"@odata.type": "microsoft.graph.itemReference"},
  "invitation": {"@odata.type": "microsoft.graph.sharingInvitation"},
  "link": {"@odata.type": "microsoft.graph.sharingLink"},
  "roles": ["string"],
  "shareId": "string"
}

プロパティProperties

プロパティProperty Type 説明Description
idid StringString 項目の全アクセス許可の中の、アクセス許可の一意の識別子です。読み取り専用。The unique identifier of the permission among all permissions on the item. Read-only.
grantedTograntedTo IdentitySetIdentitySet ユーザー タイプのアクセス許可、ユーザーとこのアクセス許可のアプリケーションの詳細。読み取り専用。For user type permissions, the details of the users & applications for this permission. Read-only.
invitationinvitation SharingInvitationSharingInvitation このアクセス許可に任意に関連付けられた共有招待状の詳細情報です。読み取り専用。Details of any associated sharing invitation for this permission. Read-only.
inheritedFrominheritedFrom ItemReferenceItemReference 現在のアクセス許可が先祖から継承されている場合、その先祖への参照を提供します。読み取り専用。Provides a reference to the ancestor of the current permission, if it is inherited from an ancestor. Read-only.
linklink SharingLinkSharingLink 現在のアクセス許可がリンク タイプのアクセス許可である場合は、そのリンクの詳細を提供します。読み取り専用。Provides the link details of the current permission, if it is a link type permissions. Read-only.
rolesroles Collection of StringCollection of String read など、アクセス許可の種類。ロールの完全なリストは以下を参照してください。読み取り専用。The type of permission, e.g. read. See below for the full list of roles. Read-only.
shareIdshareId StringString 共有 API 経由で、この共有項目にアクセスするために使用できる一意のトークン。読み取り専用です。A unique token that can be used to access this shared item via the shares API. Read-only.

permission リソースは、ファセット を使用して、リソースによって表されるアクセス許可の種類に関する情報を提供します。The permission resource uses facets to provide information about the kind of permission represented by the resource.

リンク ファセットのあるアクセス許可は、項目上に作成された共有リンクを表します。共有リンクは、リンクを持つすべてのユーザーの項目へのアクセス許可を提供する一意のトークンを含みます。Permissions with a link facet represent sharing links created on the item. Sharing links contain a unique token that provides access to the item for anyone with the link.

招待 ファセットを持つアクセス許可は、特定のユーザーやグループをファイルへのアクセスへ招待することで追加されたアクセス許可を表します。Permissions with an invitation facet represent permissions added by inviting specific users or groups to have access to the file.

ロール列挙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.
sp.owner SharePoint および OneDrive for Business の場合、これは所有者ロールを表します。For SharePoint and OneDrive for Business this represents the owner role.
sp.member SharePoint および OneDrive for Business の場合、これはメンバー ロールを表します。For SharePoint and OneDrive for Business this represents the member role.

最も一般的なアクセス許可の種類は、共有リンクです。The most common type of permissions are sharing links. 共有リンクは、共有されるリソースと、そのリソースへのアクセスを実現する認証トークンの両方を含む一意の URL を提供します。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.

表示リンクでは、項目への読み取り専用アクセスを提供します。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" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl"
}

編集リンクでは、項目への読み取りおよび書き込みアクセスを提供します。An edit link provides read and write access to an item.

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

共有の招待Sharing Invitation

共有リンクの作成に加えて、電子メール アドレスでユーザーを招待できます。In addition to creating sharing links, a user can be invited by e-mail address. このシナリオでは、ユーザーの電子メールに送信される招待状がアクセス許可によって作成されます。In this scenario the permission creates an invitation that is sent to the user's email.

電子メール アドレスへの招待状Invitation to an email address

アカウントが一致していないユーザーに電子メール アドレスでアクセス許可が送信された場合、grantedTo プロパティは、招待状が引き換えられるまで設定されません。招待状の引き換えは、ユーザーが初めてリンクをクリックしてサインインしたときに発生します。If the permission was sent via an email address to a recipient who does not have a matching account, the grantedTo property may not be set until the invitation is redeemed, which occurs the first time a user clicks the link and signs in.

{
  "id": "1",
  "roles": ["write"],
  "invitation": {
    "email": "jd@gmail.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U"
}

ユーザーによって共有の招待状が引き換えられると、grantedTo プロパティにはアクセス許可を引き換えたアカウントに関する情報が格納されます。After the sharing invitation has been redeemed by a user, the grantedTo property will contain the information about the account that redeemed the permissions:

{
  "id": "1",
  "roles": ["write"],
  "grantedTo": {
    "user": {
      "id": "5D33DD65C6932946",
      "displayName": "John Doe"
    }
  },
  "invitation": {
    "email": "jd@outlook.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U"
}

メソッドMethods

MethodMethod REST パスREST Path
アクセス許可を一覧表示するList permissions GET /drive/items/{item-id}/permissions
アクセス許可を取得するGet permission GET /drive/items/{item-id}/permissions/{id}
追加するAdd POST /drive/items/{item-id}/invite
更新するUpdate PATCH /drive/items/{item-id}/permissions/{id}
削除Delete DELETE /drive/items/{item-id}/permissions/{id}

備考Remarks

OneDrive for Business と SharePoint ドキュメント ライブラリは、inheritedFrom プロパティを返しません。OneDrive for Business and SharePoint document libraries do not return the inheritedFrom property.