次の方法で共有

共有の招待状を送信する

  • [アーティクル]

DriveItem の共有の招待状を送信します。 共有の招待状は受信者にアクセス許可を提供します。また、任意で受信者に共有リンク付きの電子メールを送信します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) Files.ReadWrite、Files.ReadWrite.All、Sites.ReadWrite.All
委任 (個人用 Microsoft アカウント) Files.ReadWrite、Files.ReadWrite.All
アプリケーション Files.ReadWrite.All、Sites.ReadWrite.All

HTTP 要求

POST /drives/{drive-id}/items/{item-id}/invite
POST /groups/{group-id}/drive/items/{item-id}/invite
POST /me/drive/items/{item-id}/invite
POST /sites/{siteId}/drive/items/{itemId}/invite
POST /users/{userId}/drive/items/{itemId}/invite

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

{
  "requireSignIn": false,
  "sendInvitation": false,
  "roles": [ "read | write"],
  "recipients": [
    { "@odata.type": "microsoft.graph.driveRecipient" },
    { "@odata.type": "microsoft.graph.driveRecipient" }
  ],
  "message": "string"
}
パラメーター 型 説明
Recipients Collection(DriveRecipient) アクセスおよび共有の招待状を受信する、受信者のコレクション。
message String 共有の招待状に含まれるプレーンテキスト形式のメッセージ。 最大の長さは 2000 文字です。
requireSignIn Boolean 共有アイテムを表示するために、招待状の受信者がサインインする必要があるかどうかを指定します。
sendInvitation Boolean True の場合、 共有リンクが受信者に送信されます。 それ以外の場合は、通知を送信せずに直接アクセス許可が付与されます。
roles Collection(String) 共有の招待状の受信者に付与されるロールを指定します。

例

次の使用例は、共同作業中のファイルに関するメッセージを含むメール アドレス "ryan@contoso.com" を持つユーザーに共有の招待を送信します。 この招待により、Ryan にはファイルへの読み取り/書き込みアクセス権が付与されます。

HTTP 要求

成功した場合、このメソッドは 200 OK 応答コードと、応答本文でアクセス許可コレクション オブジェクトを返します。

POST /me/drive/items/{item-id}/invite
Content-type: application/json

{
  "recipients": [
    {
      "email": "ryan@contoso.com"
    }
  ],
  "message": "Here's the file that we're collaborating on.",
  "requireSignIn": true,
  "sendInvitation": true,
  "roles": [ "write" ]
}

応答

以下は、応答の例です。

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "grantedTo": {
        "user": {
          "displayName": "Ryan Gregg",
          "id": "42F177F1-22C0-4BE3-900D-4507125C5C20"
        }
      },
      "id": "CCFC7CA3-7A19-4D57-8CEF-149DB9DDFA62",
      "invitation": {
        "email": "ryan@contoso.com",
        "signInRequired": true
      },
      "roles": [ "write" ]
    }
  ]
}

備考

  • personal (OneDrive 個人用) の driveType を持つドライブは、ルートの DriveItem でアクセス許可を作成したり、変更したりすることはできません。
  • 使用可能なロールの一覧は、「ロール列挙」を参照してください。

エラー応答

エラーがどのような形で返されるかについては、「エラー応答」を参照してください。