ファイルまたはフォルダーの共有アクセス許可を取得する

  • [アーティクル]

特定のアクセス許可リソースに対する、有効な共有アクセス許可を返します。

アイテムの有効なアクセス許可は、アイテム自体に直接設定されたアクセス許可、またはアイテムの先祖から継承したアクセス許可の 2 つのソースから取得できます。

呼び出し元は、inheritedFrom プロパティを確認することで、アクセス許可が継承されたものかどうかを区別できます。 このプロパティは、アクセス許可の継承元になる先祖を参照する ItemReference リソースです。

アイテムに設定された SharePoint アクセス許可レベルは、'SP' というプレフィックス付きで返されます。 たとえば、SP.View Only、SP.Limited Access、SP.View Web Analytics Data などです。 SharePoint ロールの完全なリストを参照してください。

アクセス許可

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

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

HTTP 要求

GET /drives/{drive-id}/items/{item-id}/permissions/{perm-id}
GET /groups/{group-id}/drive/items/{item-id}/permissions/{perm-id}
GET /me/drive/items/{item-id}/permissions/{perm-id}
GET /sites/{site-id}/drive/items/{item-id}/permissions/{perm-id}
GET /users/{user-id}/drive/items/{item-id}/permissions/{perm-id}

オプションのクエリ パラメーター

応答を形成するため、このメソッドは、$select クエリ パラメーター をサポートしています。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で Permission リソースを返します。

例

要求

以下は、フォルダーのアクセス許可にアクセスするための要求の例です。

GET /me/drive/items/{item-id}/permissions/{perm-id}

応答

成功した場合、このメソッドは、指定された ID の Permission リソースを返します。

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

{
  "grantedTo": {
    "user": {
      "displayName": "Ryan Gregg",
      "id": "efee1b77-fb3b-4f65-99d6-274c11914d12"
    }
  },
  "id": "1",
  "roles": [ "write" ]
}

備考

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

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

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

エラー応答

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