Permission リソース型

[アーティクル]
09/22/2023

名前空間: microsoft.graph

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

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

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

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"
}

プロパティ

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

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

リンク ファセットのあるアクセス許可は、項目上に作成された共有するリンクを表します。共有リンクは、リンクを持つすべてのユーザーのアイテムへのアクセス許可を提供する固有のトークンを含みます。

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

ロールプロパティの値

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

最も一般的なアクセス許可の種類は、リンクの共有です。共有リンクは、共有されるリソースと、そのリソースへのアクセスを実現する認証トークンの両方を含む一意の URL を提供します。ユーザーは、共有リンクによって共有されるコンテンツにアクセスするために、サインインする必要がありません。ユーザーは、コンテンツへの読み取り専用アクセス権を付与するリンク、またはコンテンツへの書き込み可能なアクセス権を付与するリンクを共有できます。

表示リンク

表示リンクでは、項目への読み取り専用アクセスを提供します。

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

編集リンク

編集リンクでは、項目への読み取りおよび書き込みアクセスを提供します。

{
  "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",
  "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"
}

既存のアクセスリンク

このリンクでは、ユーザーに追加の特権は付与されません。

{
  "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"
}

共有リンクの作成に加えて、電子メールアドレスでユーザーを招待できます。このシナリオでは、アクセス許可によって、ユーザーのメールに送信される招待が作成されます。

電子メールアドレスへの招待状

一致するアカウントを持たない受信者にメールアドレスを介してアクセス許可が送信された場合、招待が引き換えられるまで grantedTo プロパティが設定されない可能性があります。このプロパティは、ユーザーが初めてリンクを選択してサインインした場合に発生します。

{
  "id": "1",
  "roles": ["write"],
  "invitation": {
    "email": "jd@contoso.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"
}

メソッド

メソッド	REST パス
アクセス許可を一覧表示する	`GET /drive/items/{item-id}/permissions`
アクセス許可を取得する	`GET /drive/items/{item-id}/permissions/{id}`
アクセス許可を追加する	`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`

次の方法で共有

Permission リソース型

JSON 表記

プロパティ

ロールプロパティの値

表示リンク

編集リンク

特定のユーザーのリンク

既存のアクセスリンク

電子メールアドレスへの招待状

メソッド

フィードバック

その他のリソース

次の方法で共有

Permission リソース型

JSON 表記

プロパティ

ロール プロパティの値

共有リンク

表示リンク

編集リンク

特定のユーザーのリンク

既存のアクセス リンク

共有の招待

電子メール アドレスへの招待状

メソッド

フィードバック

その他のリソース

ロールプロパティの値

既存のアクセスリンク

電子メールアドレスへの招待状