MS OneDrive – Get Libraries

Estimated reading: 6 minutes

MS OneDrive – Get Libraries

Lists drives available through the selected user collection. It does not enumerate every SharePoint library in the tenant. The global method returns a nested collection; the LWC wrapper returns a flat array. Top and Order By are passed as OData values.

Action details

PropertyValue
Action labelMS OneDrive – Get Libraries
CategoryCloudTools
Apex class and methodGetOneDriveLibraries.getLibraries
Input typeGetOneDriveLibraries.GetOneDriveLibrariesInput
Output typeList<List<MSGraphDrive>>
AuthorizationOAuth Delegated (Authorization Code) or OAuth Application (Client Credentials).
Flow automationUse an application connector configured as the Flow default.
Microsoft Graph operationGET /v1.0/me/drives for Authorization Code Flow; otherwise GET /v1.0/users/{userIdOrPrincipalName}/drives.

Prerequisites and permissions

Configure a CloudTools Connector with Connector Type set to Microsoft 365. For delegated access, complete the current user’s Microsoft sign-in. For application access where supported, grant application permissions and administrator consent and provide the target user ID or principal name. The identity must have access to the selected drive and item.

Delegated calls generally require Files.Read; application calls generally require Files.Read.All. Broader file or site read/write permissions may also satisfy the operation. See the Microsoft operation and permissions reference.

Drive selection: For Authorization Code Flow, a populated driveId uses /drives/{driveId} and userIdOrPrincipalName is ignored. Other authorization types require userIdOrPrincipalName and use the user-scoped drive path shown above. A Library Id is a Graph drive ID and Item Id is an item within that drive; neither is a Salesforce record ID or browser URL.

Inputs

The table lists action labels, Apex field names, and Apex data types. Supply one non-null request with nonblank required text values.

InputApex fieldTypeRequiredDescription
User Id or Principal NameuserIdOrPrincipalNameStringUnless Authorization Code Flow is enabledUser id or user principal name. Ignored for Authorization Code Flow.
ToptopQueryStringNoNumber of items to return. Supply only the OData value, without $select=, $top=, $orderby=, or a full URL. Microsoft validates support.
Order ByorderbyQueryStringNoComma-separated properties to sort by. Supply only the OData value, without $select=, $top=, $orderby=, or a full URL. Microsoft validates support.

The global invocable input has no connectorId field. Direct subscriber Apex and Flow calls use CloudTools connector selection. This action does not resolve replacement tokens; resolve dynamic values before invocation. See Using Token Replacements.

Outputs

The global invocable method returns List<List<MSGraphDrive>>, with one outer entry holding the collection for the first request. An empty lookup returns an empty inner list. In Apex, read results[0]; Flow receives a collection output. The LWC library returns a flat array.

The helper maps the response collection but does not follow or return @odata.nextLink. The result can contain only the first page. Top, where exposed, is a request page-size input rather than an exhaustive lookup. There is no continuation URL input.

OutputApex fieldTypeDescription
IdidStringUnique identifier for the library (drive).
NamenameStringName of the library (drive).
Library TypedriveTypeStringType of library (drive).
Web UrlwebUrlStringWeb URL for the library (drive).
Created Date TimecreatedDateTimeStringCreated date time for the library (drive).
Last Modified Date TimelastModifiedDateTimeStringLast modified date time for the library (drive).
OData TypeodataTypeStringOData type for the library (drive).
Additional PropertiesadditionalPropertiesList<DynamicObject>Additional properties from user-defined query.

Use in Flow

Add MS OneDrive – Get Libraries in Flow Builder. Use a Microsoft 365 application connector configured as Set as default for Flow automations, supply the target user and resource IDs, and handle faults. Delegated connections are not supported for CloudTools Flow automation. This implementation processes only the first request; it is not a bulk operation.

Use in custom Apex

This subscriber-org example uses the Apptigent namespace. Replace all identifiers and run in a context that permits callouts with a configured connector. The example supplies the user for application access; omit it for an already-authorized delegated connector.

Apptigent.GetOneDriveLibraries.GetOneDriveLibrariesInput request =
    new Apptigent.GetOneDriveLibraries.GetOneDriveLibrariesInput();
request.userIdOrPrincipalName = 'REPLACE_WITH_MICROSOFT_USER_ID_OR_UPN';

List<List<Apptigent.MSGraphDrive>> results =
    Apptigent.GetOneDriveLibraries.getLibraries(
        new List<Apptigent.GetOneDriveLibraries.GetOneDriveLibrariesInput>{ request }
    );

List<Apptigent.MSGraphDrive> items = results.isEmpty()
    ? new List<Apptigent.MSGraphDrive>() : results[0];
System.debug(items.size());

The example leaves exception handling, authorization setup, and presentation or persistence of the result to the calling application.

Use in a Lightning Web Component

Use getOneDriveLibraries from msOneDriveConnectorLib, through MSOneDriveConnectorController. These repository c/ imports apply to an LWC in the same namespace. Complete connector authorization before use.

Connector selection limitation: The wrapper accepts a second connectorId argument, but the current controller/action path does not forward it to select the Graph connector for this operation. Calls use CloudTools default connector selection. Passing a connectorId does not guarantee that this action uses that record.

oneDriveActionExample.js

import { LightningElement } from 'lwc';
import { getOneDriveLibraries, MSOneDriveObjects } from 'c/msOneDriveConnectorLib';

export default class OneDriveActionExample extends LightningElement {
    connectorId = 'REPLACE_WITH_CONNECTOR_RECORD_ID';
    result = null;
    errorMessage = '';
    isRunning = false;
    completed = false;

    async handleRun() {
        if (this.isRunning) {
            return;
        }
        this.isRunning = true;
        this.errorMessage = '';
        try {
            const request = MSOneDriveObjects.inputs.getOneDriveLibraries();
            request.userIdOrPrincipalName = 'REPLACE_WITH_MICROSOFT_USER_ID_OR_UPN';
            const result = await getOneDriveLibraries(request);
            if (!Array.isArray(result)) {
                throw new Error('The action did not return a usable result.');
            }
            this.result = result;
            this.completed = true;
        } catch (error) {
            this.errorMessage = error.requiresInteractiveAuthorization
                ? 'Sign in to Microsoft for the connector, then try again.'
                : error.message || 'The OneDrive action failed.';
        } finally {
            this.isRunning = false;
        }
    }
}

oneDriveActionExample.html

<template>
    <lightning-button label="Run action" onclick={handleRun}
        disabled={isRunning}></lightning-button>
    <p role="alert">{errorMessage}</p>
</template>

The library resolves to a flat array, without an outer Apex list.

The controller adds rawJson as a serialization of the mapped Apex object. This does not preserve Microsoft fields omitted from the model and is not an invocable Flow output.

For delegated sign-in, use getOneDriveAuthorizationState, beginOneDriveAuthorization, and createOneDriveOAuthMessageHandler. The example only reports errors. This controller path converts failures to plain Aura-handled messages, so requiresInteractiveAuthorization is not guaranteed. Use the authorization-state helper before calling and handle message-only failures.

Error handling and troubleshooting

SymptomWhat to check
Required fields errorProvide a nonempty request list with a non-null first item and the required identifiers. Supply the user for non-delegated connectors.
Authorization or access deniedCheck connector selection, Microsoft sign-in, consent, permission type, and access to the drive or item.
Resource not foundVerify driveId, itemId, and any version or permission ID. Keep related IDs associated with their source drive.
Missing fields or itemsCheck Select, item type, mapping limitations, and first-page behavior. Empty results and omitted fields are not proof that a resource does not exist.
Unexpected connectorReview the connector selection limitation above and the Microsoft 365 Flow default.
Operation rejectedInspect the Microsoft error, item state, library capability, and tenant policy. Handle exceptions or structured Result failures in the caller.
Share this Doc

MS OneDrive – Get Libraries

Or copy link

CONTENTS

Free eBook: The Ultimate Guide to Power Platform Custom Connectors

Antimanual

Ask our AI support assistant your questions about our platform, features, and services.

You are offline
Chatbot avatar
What can I help you with?

Subscribe

×
Cancel