MS Entra – Groups – Download Library Item
MS Entra – Groups – Download Library Item
Download a file from a group document library.
Action details
| Property | Value |
|---|---|
| Action label | MS Entra – Groups – Download Library Item |
| Category | CloudTools |
| Apex class and method | DownloadEntraGroupLibraryItem.downloadLibraryItem |
| Input type | DownloadEntraGroupLibraryItem.DownloadEntraGroupLibraryItemInput |
| Output type | List<MSGraphDriveFile> |
| Authorization | Microsoft 365 connector; supported authorization depends on the endpoint and target. |
| Microsoft Graph request | GET /groups/{groupId}/drives/{driveId}/items/{itemId}, then GET the /content endpoint |
Prerequisites and permissions
Configure a CloudTools Connector with Connector Type set to Microsoft 365. Complete sign-in for OAuth Delegated (Authorization Code). For supported OAuth Application (Client Credentials) requests, grant application permissions and administrator consent. The identity must have access to the selected resource; directory operations can also require Microsoft Entra roles. Use Creating an Entra ID App and Integration Connectors for setup.
The action permission provider declares these alternatives. They are not cumulative requirements or universally interchangeable; check the Microsoft reference for endpoint, target, and property restrictions.
| Permission type | Declared alternatives |
|---|---|
| Delegated | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
| Application | Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
Endpoints: /groups/{groupId}/drives/{driveId}/items/{itemId}, then GET the /content endpoint. File and site scopes depend on the resource and tenant policy.
See the Microsoft operation and permissions reference.
Inputs
| Input | Apex field | Type | Required | Description |
|---|---|---|---|---|
| Group Id | groupId | String | Yes | Group identifier |
| Library Id | driveId | String | Yes | Library (drive) identifier |
| Item Id | itemId | String | Yes | Library (drive) item identifier |
Supply a nonempty list with a non-null first request. Graph actions process only that first request. Global inputs do not expose connectorId; subscriber Apex and Flow use CloudTools connector selection. Use Microsoft Graph resource IDs or the specifically documented user identifier, and resolve dynamic values before invocation.
Outputs
Returns one mapped MSGraphDriveFile inside a list. Check the actual result shape and fields before use.
| Output | Apex field | Type | Description |
|---|---|---|---|
| Mime Type | mimeType | String | MIME content type of the file |
| File Name | fileName | String | File name |
| File | file | Blob | Binary file content |
Behavior and limits
This wrapper delegates the Graph operation to a shared file helper. It does not pass an explicit connector record ID to that helper, which initializes the default MSENTRA connector. A controller request.connectorId does not select the connection used by the delegated file call.
Returns MIME type, file name, and a Blob. The shared helper can follow Microsoft content redirect/download behavior. Your caller must explicitly save the Blob to Salesforce when needed.
Use in Flow
Use MS Entra – Groups – Download Library Item where supported. Use a Microsoft 365 application connector configured as Set as default for Flow automations only if the endpoint and target support application access. Supply required values, retain useful outputs, and add fault handling. Delegated connections are not supported for CloudTools Flow automation. The action processes only the first input request.
Use in custom Apex
This subscriber-org example uses the Apptigent namespace. Replace identifiers and example values before use. Configure the connector, complete authorization first, run in a context permitting callouts, and handle exceptions, empty results, and unmapped fields.
Apptigent.DownloadEntraGroupLibraryItem.DownloadEntraGroupLibraryItemInput request =
new Apptigent.DownloadEntraGroupLibraryItem.DownloadEntraGroupLibraryItemInput();
request.groupId = 'f11f1340-30b1-4f1d-91ec-c853b7245646';
request.driveId = 'b!X5oVvJY9mkCm2tS6Dpo0Q6';
request.itemId = '01ABCDEF23456789!123';
List<Apptigent.MSGraphDriveFile> results =
Apptigent.DownloadEntraGroupLibraryItem.downloadLibraryItem(
new List<Apptigent.DownloadEntraGroupLibraryItem.DownloadEntraGroupLibraryItemInput>{ request }
);
System.debug(results);
Use in a Lightning Web Component
Use downloadEntraGroupLibraryItem from msEntraConnectorLib through MSEntraConnectorController. These c/ imports apply in the same namespace. Set request.connectorId for direct MSEntraAction calls. This action delegates to a file helper using the default connection; the request selection does not reach that file call.
| Global input | LWC request mapping |
|---|---|
groupId | request.groupId |
driveId | request.driveId |
itemId | request.itemId |
entraActionExample.js
import { LightningElement } from 'lwc';
import { downloadEntraGroupLibraryItem } from 'c/msEntraConnectorLib';
export default class EntraActionExample extends LightningElement {
result = null;
errorMessage = '';
isRunning = false;
completed = false;
async handleRun() {
if (this.isRunning || this.completed) return;
this.isRunning = true;
this.errorMessage = '';
try {
const request = { connectorId: 'REPLACE_WITH_CONNECTOR_RECORD_ID' };
request.groupId = 'f11f1340-30b1-4f1d-91ec-c853b7245646';
request.driveId = 'b!X5oVvJY9mkCm2tS6Dpo0Q6';
request.itemId = '01ABCDEF23456789!123';
this.result = await downloadEntraGroupLibraryItem(request);
this.completed = true;
} catch (error) {
this.errorMessage = error.requiresInteractiveAuthorization
? 'Sign in to Microsoft for the connector, then try again.'
: error.message || 'The Entra action failed.';
} finally {
this.isRunning = false;
}
}
}
entraActionExample.html
<template>
<lightning-button label="Run action" onclick={handleRun}
disabled={isRunning}></lightning-button>
<p role="alert">{errorMessage}</p>
</template>
The library returns one mapped DTO or null. The controller can flatten nested fields, serialize data, or map an action result into an operation DTO. rawJson contains serialized mapped Apex data rather than the untouched Graph response.
The LWC drive-file DTO contains mimeType, fileName, and base64File. Decode or store the base64 value explicitly when needed; it is not a Salesforce File ID.
Use getMSEntraAuthorizationState, beginMSEntraAuthorization, and createMSEntraOAuthMessageHandler to arrange delegated sign-in. The library normalizes errors but does not automatically sign in or retry. Reset completed for a new deliberate operation, and inspect resource state before retrying a mutation with an uncertain outcome.
Error handling and troubleshooting
| Symptom | What to check |
|---|---|
| Required fields error | Supply a nonempty request list and required or conditionally required inputs. For LWC, use the mapped field names. |
| Authorization or access denied | Check connector selection, sign-in, endpoint/target permission support, administrator consent, directory roles, and resource access. |
| Resource not found | Check Microsoft IDs and parent resource relationships. Preserve group/drive/item associations and mailbox/calendar/event IDs. |
| Missing or unexpected output | Check query support, pagination, wrapper versus item models, public-only properties, and mapped DTO fields. |
| Operation rejected | Inspect the Microsoft error, supported writable fields, group/calendar restrictions, recipient/license data, and file transfer limits. |