共有の招待状を送信する

DriveItem の共有の招待状を送信します。共有の招待状は受信者にアクセス許可を提供します。また、任意で受信者に、アイテムが共有されたことを通知する電子メールを送信します。

前提条件

この API を実行するには、以下のいずれかのスコープが必要です。

  • Files.ReadWrite

HTTP 要求

POST /me/drive/items/{item-id}/invite
POST /drive/items/{item-id}/invite
POST /drives/{drive-id}/items/{item-id}/invite
POST /groups/{group-id}/drive/items/{item-id}/invite

要求本文

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

パラメーター 説明
Recipients Collection(DriveRecipient) アクセスおよび共有の招待状を受信する、受信者のコレクション。
message String 共有の招待状に含まれるプレーンテキスト形式のメッセージ。最大の長さは 2000 文字です。
requireSignIn Boolean 共有アイテムを表示するために、招待状の受信者がサインインする必要のある場所を指定します。
sendInvitation Boolean 電子メールまたは投稿が生成されるのか (false)、アクセス許可のみが作成されるのか (true) を指定します。
roles Collection(String) 共有の招待状の受信者に付与されるロールを指定します。

応答

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

以下は、この API を呼び出す方法の例です。

要求

以下は、要求の例です。

POST https://graph.microsoft.com/v1.0/drive/items/{item-id}/invite
Content-type: application/json

{
  "recipients": [
    {
      "email": "ryan@contoso.org"
    }
  ],
  "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 Personal) の driveType を持つドライブは、ルートの DriveItem でアクセス許可を作成したり、変更したりすることはできません。
  • 使用可能なロールの一覧は、「ロール列挙」を参照してください。