アクセス許可リソースの種類

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

アクセス許可リソースは、driveItem リソースに付与された共有アクセス許可に関する情報を提供します。

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

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

OneDrive for Business および SharePoint ドキュメント ライブラリは inheritedFrom プロパティを返しません。 grantedTograntedToIdentities は今後非推奨となり、応答は適切なプロパティ名でそれぞれ grantedToV2grantedToIdentitiesV2 に移行されます。

メソッド

メソッド 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
アクセス許可を更新する PATCH /drive/items/{item-id}/permissions/{id}
アクセス許可を削除する DELETE /drive/items/{item-id}/permissions/{id}
共有リンクへのアクセスを許可する POST /shares/{encoded-sharing-url}/permission/grant
共有リンクで付与を取り消す POST /drive/items/{item-id}/permissions/{id}/revokeGrants

プロパティ

プロパティ 説明
id String 項目の全アクセス許可の中の、アクセス許可の一意の識別子です。 読み取り専用です。
grantedToV2 SharePointIdentitySet ユーザーの種類のアクセス許可の場合、このアクセス許可のユーザーとアプリケーションの詳細。 読み取り専用です。
grantedToIdentitiesV2 Collection(SharePointIdentitySet) リンク型のアクセス許可の場合、アクセス許可が付与されたユーザーの詳細。 読み取り専用です。
invitation SharingInvitation このアクセス許可に任意に関連付けられた共有招待状の詳細情報です。 読み取り専用。
inheritedFrom ItemReference 親祖から継承されている場合は、現在のアクセス許可の親祖への参照を提供します。 読み取り専用です。
link SharingLink 現在のアクセス許可のリンク詳細を提供します (リンクの種類のアクセス許可の場合)。 読み取り専用です。
roles Collection(String) アクセス許可の種類 などread。 ロールの完全な一覧については、「ロールのプロパティ値」セクションを参照してください。 読み取り専用。
shareId String 共有 API 経由で、この共有項目にアクセスするために使用できる一意のトークン。 読み取り専用。
expirationDateTime DateTimeOffset DateTimeOffset の yyyy MM-ddTHH: mm: ssZ 形式は、アクセス許可の有効期限を示します。 DateTime.MinValue は、このアクセス許可に有効期限が設定されていないことを示します。 オプション。
hasPassword ブール型 このアクセス許可にパスワードが設定されているかどうかを示します。 このプロパティは、応答にのみ表示されます。 省略可能。 読み取り専用です。 OneDrive Personal の場合のみ。
grantedTo (非推奨) IdentitySet ユーザーの種類のアクセス許可の場合、このアクセス許可のユーザーとアプリケーションの詳細。 読み取り専用です。
grantedToIdentities (非推奨) コレクション (IdentitySet) 種類のアクセス許可の場合、アクセス許可が付与されたユーザーの詳細。 読み取り専用です。

ロール プロパティの値

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

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

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

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

リレーションシップ

なし。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "id": "string (identifier)",
  "grantedTo": {"@odata.type": "microsoft.graph.identitySet"},
  "grantedToIdentities": [{"@odata.type": "microsoft.graph.identitySet"}],
  "grantedToV2": {"@odata.type": "microsoft.graph.sharePointIdentitySet"},
  "grantedToIdentitiesV2": [{"@odata.type": "microsoft.graph.sharePointIdentitySet"}],
  "inheritedFrom": {"@odata.type": "microsoft.graph.itemReference"},
  "invitation": {"@odata.type": "microsoft.graph.sharingInvitation"},
  "link": {"@odata.type": "microsoft.graph.sharingLink"},
  "roles": ["string"],
  "shareId": "string",
  "expirationDateTime": "string (timestamp)",
  "hasPassword": "boolean"
}

注釈

リンク ファセットのあるアクセス許可は、項目上に作成された共有するリンクを表します。 この種類のアクセス許可が最も一般的に使用されます。 共有リンクは、ファイルまたはフォルダーへのアクセスに使用できる一意の 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",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

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

{
  "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",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

このリンクは、ユーザーに追加の権限を付与しません。

{
  "id": "00000000-0000-0000-0000-000000000000",
  "roles": ["read"],
  "link": {
    "scope": "existingAccess",
    "type": "view",
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/Shared%20Documents/SampleDoc.docx?d=w12345",
  },
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

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

{
  "id": "3",
  "grantedToIdentities": [
    {
       "user": {
        "id": "35fij1974gb8832",
        "displayName": "Misty Suarez"
      }
    },
    {
       "user": {
        "id": "9397721fh4hgh73",
        "displayName": "Judith Clemons"
      }
    }
  ],
  "grantedToIdentitiesV2": [
    {
       "user": {
        "id": "35fij1974gb8832",
        "displayName": "Misty Suarez"
      },
      "siteUser": {
        "id": "1",
        "displayName": "Misty Suarez",
        "loginName": "Misty Suarez"
      }
    },
    {
       "user": {
        "id": "9397721fh4hgh73",
        "displayName": "Judith Clemons"
      },
      "siteUser": {
        "id": "2",
        "displayName": "Judith Clemons",
        "loginName": "Judith Clemons"
      }
    }
  ],
  "roles": ["write"],
  "link": {
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

招待状を共有する

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

{
  "id": "1",
  "roles": ["write"],
  "invitation": {
    "email": "jd@fabrikam.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

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

{
  "id": "1",
  "roles": ["write"],
  "grantedTo": {
    "user": {
      "id": "5D33DD65C6932946",
      "displayName": "Robin Danielsen"
    }
  },
  "grantedToV2": {
    "user": {
      "id": "5D33DD65C6932946",
      "displayName": "Robin Danielsen"
    },
    "siteUser": {
      "id": "1",
      "displayName": "Robin Danielsen",
      "loginName": "Robin Danielsen"
    }
  },
  "invitation": {
    "email": "rd@contoso.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}