Get Drive

• 09/10/2017
• 4 minutes to read
• Contributors
  • 
  • 
  • 
  • 
  • 
  • all

Retrieve the properties and relationships of a Drive resource.

A Drive is the top-level container for a file system, such as OneDrive or SharePoint document libraries.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Get current user's OneDrive

The signed in user's drive (when using delegated authentication) can be accessed from the me singleton.

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 request

GET /me/drive

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var drive = await graphClient.Me.Drive
	.Request()
	.GetAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

let res = await client.api('/me/drive')
	.get();

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

Get a user's OneDrive

To access a user's OneDrive or OneDrive for Business, your app must request the drive relationship on the User resource.

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 request

GET /users/{idOrUserPrincipalName}/drive

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var drive = await graphClient.Users["{idOrUserPrincipalName}"].Drive
	.Request()
	.GetAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

let res = await client.api('/users/{idOrUserPrincipalName}/drive')
	.get();

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

Path parameters

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 request

GET /groups/{groupId}/drive

Path parameters

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 request

GET /sites/{siteId}/drive

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var drive = await graphClient.Groups["{groupId}"].Drive
	.Request()
	.GetAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

let res = await client.api('/groups/{groupId}/drive')
	.get();

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

Path parameters

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 request

GET /drives/{drive-id}

Path parameters

Optional query parameters

These method support the $select query parameter to shape the response.

Response

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
    }
}

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var drive = await graphClient.Drives["{drive-id}"]
	.Request()
	.GetAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

let res = await client.api('/drives/{drive-id}')
	.get();

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

Error response codes

If the drive does not exist and cannot be provisioned automatically (when using delegated authentication) an HTTP 404 response will be returned.