Permission リソース型

  • [アーティクル]

Permission リソースは、DriveItem リソースに付与された共有アクセス許可についての情報を提供します。

共有アクセス許可にはさまざまなフォームがあります。 Permission リソースは、これらのさまざまなフォームをリソースのファセットを通じて表します。

JSON 表記

以下は、リソースの JSON 表記です

{
  "id": "string (identifier)",
  "grantedTo": {"@odata.type": "microsoft.graph.identitySet"},
  "grantedToIdentities": [{"@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"
}

プロパティ

プロパティ 型 説明
id String 項目の全アクセス許可の中の、アクセス許可の一意の識別子です。 読み取り専用。
grantedTo IdentitySet ユーザー タイプのアクセス許可、ユーザーとこのアクセス許可のアプリケーションの詳細。 読み取り専用です。
grantedToIdentities コレクション (IdentitySet) リンク型のアクセス許可の場合、アクセス許可が付与されたユーザーの詳細。 読み取り専用です。
invitation SharingInvitation このアクセス許可に任意に関連付けられた共有招待状の詳細情報です。 読み取り専用。
inheritedFrom ItemReference 現在のアクセス許可が先祖から継承されている場合、その先祖への参照を提供します。 読み取り専用。
link SharingLink 現在のアクセス許可がリンク タイプのアクセス許可である場合は、そのリンクの詳細を提供します。 読み取り専用です。
roles Collection(String) read など、アクセス許可の種類。 ロールの完全なリストは以下を参照してください。 読み取り専用。
shareId String 共有 API 経由で、この共有項目にアクセスするために使用できる一意のトークン。 読み取り専用。

ロール列挙

ロール 詳細
read 項目のメタデータと内容を読み取る機能を提供します。
write 項目のメタデータと内容の読み取りと変更の機能を提供します。
owner SharePoint および OneDrive for Business の場合、これは所有者ロールを表します。
member SharePoint および OneDrive for Business の場合、これはメンバー ロールを表します。

permission リソースは、ファセットを使用して、リソースによって表されるアクセス許可の種類に関する情報を提供します。

共有リンクには、アイテムにアクセスするために必要な一意のトークンが含まれます。

招待ファセットを持つアクセス許可は、ファイルへのアクセス権を持つ特定のユーザーまたはグループを招待することによって追加されたアクセス許可を表します。

リンク ファセットのあるアクセス許可は、項目上に作成された共有するリンクを表します。 これらは最も一般的な種類のアクセス許可です。 共有リンクは、ファイルまたはフォルダーへのアクセスに使用できる一意の URL を提供します。 さまざまな方法でアクセスを許可するように設定できます。 たとえば、 createLink API を使用して、組織にサインインしているユーザー全員に有効なリンクを作成したり、サインインしなくても誰にでも有効なリンクを作成したりすることができます。 招待 API を使用して、会社にいるかどうかにかかわらず、特定のユーザにのみ有効なリンクを作成することができます。

ここでは、共有リンクの例をいくつか示します。

この表示リンクは、リンクを持っている全員に読み取り専用アクセスを提供します。

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

この編集リンクは、リンクを持っている組織内の全員に読み取りと書き込みアクセスを提供します。

{
  "id": "2ceefb3g32hh",
  "roles": ["write"],
  "link": {
    "scope": "organization",
    "type": "edit",
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/fj277ghautbb422707565gnvg23",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl"
}

このリンクは、grantedToIdentities コレクション内の特定のユーザーに読み取りと書き込みアクセスを提供します。

{
  "id": "3",
  "grantedToIdentities": [
    {
       "user": {
        "id": "35fij1974gb8832",
        "displayName": "Misty Suarez"
      }
    },
    {
       "user": {
        "id": "9397721fh4hgh73",
        "displayName": "Judith Clemons"
      }
    }
  ],
  "roles": ["write"],
  "link": {
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl"
}

共有招待状

招待 API によって送信されるアクセス許可には、招待ファセットに追加情報が含まれる場合があります。 既知のアカウントと一致しないメール アドレスに招待状が送信された場合、grantedTo プロパティは、招待状が引き換えられるまで設定されません。招待状の引き換えは、ユーザーが初めてリンクをクリックしてサインインしたときに発生します。

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

ユーザーによって共有の招待状が引き換えられると、grantedTo プロパティにはアクセス許可を引き換えたアカウントに関する情報が格納されます。

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

メソッド

Method REST パス
アクセス許可を一覧表示する GET /drive/items/{item-id}/permissions
アクセス許可を取得する GET /drive/items/{item-id}/permissions/{id}
作成リンク POST /drive/items/{item-id}/createLink
ユーザーを招待する POST /drive/items/{item-id}/invite
Update PATCH /drive/items/{item-id}/permissions/{id}
削除 DELETE /drive/items/{item-id}/permissions/{id}

備考

OneDrive for Business と SharePoint ドキュメント ライブラリは、inheritedFrom プロパティを返しません。