フィードバック 編集

アクセス許可: grant

  • [アーティクル]

名前空間: microsoft.graph

アクセス許可によって表されるリンクへのアクセス権をユーザーに付与 [します][]。

アクセス許可

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

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

HTTP 要求

POST /shares/{encoded-sharing-url}/permission/grant

要求ヘッダー

名前 説明
Authorization ベアラー {トークン}。必須。

要求本文

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

{
  "recipients": [
    { "@odata.type": "microsoft.graph.driveRecipient" }
  ],
  "roles": [ "read | write"]
}
パラメーター 種類 説明
Recipients Collection(driveRecipient) アクセスを受け取る受信者のコレクション。
roles Collection(String) リンクが "既存のアクセス" リンクである場合は、ユーザーに付与する役割を指定します。 それ以外の場合は、リンクの役割と一致する必要があります。

使用可能な役割の一覧については、「 roles プロパティの値」を参照してください。

応答

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

更新 [されたリンク][] を表すアクセス許可は、成功すると常に結果セットに返されます。 更新されたリンクは、'scope' プロパティを含む 'link' ファセットが存在することで識別できます。 場合によっては、更新されたリンクの URL が元のリンクとは異なる場合があります。この場合、新しい URL を使用する必要があります。

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

例

この例では、リンク john@contoso.com 既存 ryan@external.com 変更せずに、共有リンクへのアクセス権をユーザーに付与します。

要求

POST https://graph.microsoft.com/v1.0/shares/{encoded-sharing-url}/permission/grant
Content-type: application/json

{
  "recipients": [
    {
      "email": "john@contoso.com"
    },
    {
      "email": "ryan@external.com"
    }
  ],
  "roles": ["read"]
}

応答

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

{
  "value": [
    {
      "hasPassword": false,
      "id": "5fab944a-47ec-48d0-a9b5-5178a926d00f",
      "link": {
        "preventsDownload": false,
        "scope": "users",
        "type": "view",
        "webUrl": "https://contoso.sharepoint.com/:t:/g/design/EZexPoDjW4dMtKFUfAl6BK4BvIUuss52hLYzihBfx-PD6Q"
      },
      "roles": [
        "read"
      ]
    }
  ]
}

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

リンクが既存のアクセス リンクの 場合、次の表に示す追加のアクセス許可が返されます。

  • アクセスが正常に許可された受信者を表すユーザー型のアクセス許可。 これらは、grantedTo プロパティの存在 によって識別 できます。
  • アクセス権を得るために認識されていない外部ユーザーに送信する必要がある招待状を表すリンク型のアクセス許可。 これらは、招待ファセットが存在することで 識別 できます。 これらのエントリには招待 URL とのリンクが含まれるので、grantedToIdentities コレクションはリンクの送信先ユーザーを示します。
HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "hasPassword": false,
      "id": "00000000-0000-0000-0000-000000000000",
      "link": {
        "preventsDownload": false,
        "scope": "existingAccess",
        "type": "view",
        "webUrl": "https://contoso.sharepoint.com/teams/design/shareddocs/Document.docx"
      },
      "roles": [
        "read"
      ]
    },
    {
      "grantedTo": {
        "user": {
          "displayName": "John Smith",
          "email": "john@contoso.com",
          "id": "47aecee2-d061-4730-8ecb-4c61360441ae"
        }
      },
      "id": "aTowIy5mfG1lbWJlcnNoaXB8bGltaXRlZDJAa2xhbW9kYi5vbm1pY3Jvc29mdC5jb20",
      "roles": [
        "read"
      ]
    },
    {
      "grantedToIdentities": [
        {
          "user": {
            "email": "ryan@external.com"
          }
        }
      ],
      "invitation": {
        "signInRequired": true
      },
      "roles": [
        "read"
      ],
      "link": {
        "type": "view",
        "webUrl": "https://contoso.sharepoint.com/:t:/g/teams/design/EZexPoDjW4dMtKFUfAl6BK4Bw_F7gFH63O310A7lDtK0mQ"
      }
    }
  ]
}

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。