ドライブを取得するGet Drive

Drive リソースのプロパティと関係を取得します。Retrieve the properties and relationships of a Drive resource.

ドライブとは、OneDrive または SharePoint のドキュメント ライブラリなど、ファイル システムの最上位コンテナーです。A Drive is the top-level container for a file system, such as OneDrive or SharePoint document libraries.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.AllFiles.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.AllFiles.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All
アプリケーションApplication Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.AllFiles.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

現在のユーザーの OneDrive を取得するGet current user's OneDrive

(委任された認証を使用する場合) me シングルトンから、サインイン ユーザーのドライブにアクセスできます。The signed in user's drive (when using delegated authentication) can be accessed from the me singleton.

ユーザーの OneDrive はプロビジョニングされていないものの、ユーザーが OneDrive を使用するライセンスを持っている場合、委任された認証を使用するときに、この要求によりユーザーのドライブは自動的にプロビジョニングされます。If a user's OneDrive is not provisioned but the user has a license to use OneDrive, this request will automatically provision the user's drive, when using delegated authentication.

HTTP 要求HTTP request

GET /me/drive

ユーザーの OneDrive を取得するGet a user's OneDrive

ユーザーの OneDrive または OneDrive for Business にアクセスするには、User リソースについてのドライブ リレーションシップをアプリが要求する必要があります。To access a user's OneDrive or OneDrive for Business, your app must request the drive relationship on the User resource.

ユーザーの OneDrive はプロビジョニングされていないものの、ユーザーが OneDrive を使用するライセンスを持っている場合、委任された認証を使用するときに、この要求によりユーザーのドライブは自動的にプロビジョニングされます。If a user's OneDrive is not provisioned but the user has a license to use OneDrive, this request will automatically provision the user's drive, when using delegated authentication.

HTTP 要求HTTP request

GET /users/{idOrUserPrincipalName}/drive

パス パラメーターPath parameters

パラメーター名Parameter name Value 説明Description
idOrUserPrincipalNameidOrUserPrincipalName stringstring 必須。Required. OneDrive を所有するユーザー オブジェクトの識別子。The identifier for the user object who owns the OneDrive.

グループに関連付けられたドキュメント ライブラリを取得するGet the document library associated with a group

グループの既定のドキュメント ライブラリにアクセスするには、そのグループについてのドライブ リレーションシップをアプリが要求する必要があります。To access a Group's default document library, your app requests the drive relationship on the Group.

HTTP 要求HTTP request

GET /groups/{groupId}/drive

パス パラメーターPath parameters

パラメーター名Parameter name Value 説明Description
groupIdgroupId stringstring 必須。Required. ドキュメント ライブラリを所有するグループの識別子。The identifier for the group which owns the document library.

サイトのドキュメント ライブラリを取得するGet the document library for a site

サイトの既定のドキュメント ライブラリにアクセスするには、そのサイトについてのドライブ リレーションシップをアプリが要求する必要があります。To access a Site's default document library, your app requests the drive relationship on the Site.

HTTP 要求HTTP request

GET /sites/{siteId}/drive

パス パラメーターPath parameters

パラメーター名Parameter name Value 説明Description
siteIdsiteId stringstring 必須。Required. ドキュメント ライブラリを含むサイトの識別子。The identifier for the site that contains the document library.

ID によりドライブを取得するGet a drive by ID

ドライブの一意の識別子を持っている場合、最上位ドライブのコレクションから直接アクセスできます。If you have the unique identifier for a drive, you can access it directly from the top-level drives collection.

HTTP 要求HTTP request

GET /drives/{drive-id}

パス パラメーターPath parameters

パラメーター名Parameter name Value 説明Description
driveIddriveId stringstring 必須。 要求されるドライブの識別子。Required. The identifier for the drive requested.

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

応答を形成するため、これらのメソッドは $select クエリ パラメーターをサポートしています。These method support the $select query parameter to shape the response.

応答Response

各メソッドは、一致するドライブに応じた Drive リソースを応答本文で返します。Each of these methods returns a Drive resource for the matching drive in the response body.

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,
        "remaining": 1099447353539,
        "state": "normal",
        "total": 1099511627776
    }
}

エラー応答コードError response codes

(委任された認証を使用する場合) ドライブが存在しないために自動的にプロビジョニングできないなら、HTTP 404 応答が返されます。If the drive does not exist and cannot be provisioned automatically (when using delegated authentication) an HTTP 404 response will be returned.