ドライブを取得する

  • [アーティクル]

Drive リソースのプロパティと関係を取得します。

ドライブとは、OneDrive または 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

現在のユーザーの OneDrive を取得する

(委任された認証を使用する場合) me シングルトンから、サインイン ユーザーのドライブにアクセスできます。

ユーザーの OneDrive はプロビジョニングされていないものの、ユーザーが OneDrive を使用するライセンスを持っている場合、委任された認証を使用するときに、この要求によりユーザーのドライブは自動的にプロビジョニングされます。

HTTP 要求

GET /me/drive

直接 OneDrive のサービス エンドポイント を使用する場合、/me セグメントを無視します。

GET /drive

ユーザーの OneDrive を取得する

ユーザーの OneDrive または OneDrive for Business にアクセスするには、User リソースについてのドライブ リレーションシップをアプリが要求する必要があります。

ユーザーの OneDrive はプロビジョニングされていないものの、ユーザーが OneDrive を使用するライセンスを持っている場合、委任された認証を使用するときに、この要求によりユーザーのドライブは自動的にプロビジョニングされます。

HTTP 要求

GET /users/{idOrUserPrincipalName}/drive

パス パラメーター

パラメーター名 値 説明
idOrUserPrincipalName string 必須。 OneDrive を所有するユーザー オブジェクトの識別子。

グループに関連付けられたドキュメント ライブラリを取得する

グループの既定のドキュメント ライブラリにアクセスするには、そのグループについてのドライブ リレーションシップをアプリが要求する必要があります。

HTTP 要求

GET /groups/{groupId}/drive

パス パラメーター

パラメーター名 値 説明
groupId string 必須。 ドキュメント ライブラリを所有するグループの識別子。

サイトのドキュメント ライブラリを取得する

サイトの既定のドキュメント ライブラリにアクセスするには、そのサイトについてのドライブ リレーションシップをアプリが要求する必要があります。

HTTP 要求

GET /sites/{siteId}/drive

パス パラメーター

パラメーター名 値 説明
siteId string 必須。 ドキュメント ライブラリを含むサイトの識別子。

ID によりドライブを取得する

ドライブの一意の識別子を持っている場合、最上位ドライブのコレクションから直接アクセスできます。

HTTP 要求

GET /drives/{drive-id}

パス パラメーター

パラメーター名 値 説明
driveId string 必須。 要求されるドライブの識別子。

省略可能なクエリ パラメーター

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

HTTP 応答

各メソッドは、一致するドライブに応じた Drive リソースを応答本文で返します。

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

{
    "id": "b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7",
    "driveType": "business",
    "owner": {
        "user": {
            "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
            "displayName": "Ryan Gregg"
        }
    },
    "quota": {
        "deleted": 256938,
        "fileCount": 2,
        "remaining": 1099447353539,
        "state": "normal",
        "total": 1099511627776
    }
}

エラー応答コード

(委任された認証を使用する場合) ドライブが存在しないために自動的にプロビジョニングできないなら、HTTP 404 応答が返されます。