次の方法で共有


共有の招待状を送信する

名前空間: microsoft.graph

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

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この 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

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、次のパラメーターを含む 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) 共有招待の受信者に付与するロールを指定します。
expirationDateTime DateTimeOffset アクセス許可の有効期限が切れる dateTime を指定します。 OneDrive for Businessと SharePoint の場合、xpirationDateTimesharingLink アクセス許可にのみ適用されます。 OneDrive for Business、SharePoint、Premium 個人用 OneDrive アカウントで使用できます。
パスワード String 作成者による招待に設定されたパスワード。 オプションと OneDrive Personal のみ。
retainInheritedPermissions ブール値 省略可能。 (既定値) の場合 true 、このアイテムを初めて共有するときに、既存の継承されたアクセス許可が共有アイテムに保持されます。 の場合 false、共有時に既存のすべてのアクセス許可が初めて削除されます。

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

HTTP 要求

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

POST https://graph.microsoft.com/v1.0/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" ],
  "password": "password123",
  "expirationDateTime": "2018-07-15T14:00:00.000Z"
}

応答

次の例は応答を示しています。

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

{
  "value": [
    {
      "@deprecated.GrantedTo": "GrantedTo has been deprecated. Refer to GrantedToV2",
      "grantedTo": {
        "user": {
          "displayName": "Robin Danielsen",
          "id": "42F177F1-22C0-4BE3-900D-4507125C5C20"
        }
      },
      "grantedToV2": {
        "user": {
          "id": "42F177F1-22C0-4BE3-900D-4507125C5C20",
          "displayName": "Robin Danielsen"
        },
        "siteUser": {
          "id": "1",
          "displayName": "Robin Danielsen",
          "loginName": "Robin Danielsen"
        }
      },
      "hasPassword": true,
      "id": "CCFC7CA3-7A19-4D57-8CEF-149DB9DDFA62",
      "invitation": {
        "email": "robin@contoso.com",
        "signInRequired": true
      },
      "roles": [ "write" ],
      "expirationDateTime": "2018-07-15T14:00:00.000Z"
    }
  ]
}

備考

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

エラー応答

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