From 9d1e98244c8ecd1eacd5a8e4225ed829324641a0 Mon Sep 17 00:00:00 2001 From: Suvarna I S Date: Fri, 27 Mar 2026 17:40:41 +0530 Subject: [PATCH] W-21780109-Microsoft-OneDrive-Connector-1.2.0-minor-release-sis --- microsoft-onedrive/1.2/antora.yml | 18 + microsoft-onedrive/1.2/modules/ROOT/nav.adoc | 3 + .../1.2/modules/ROOT/pages/index.adoc | 53 + ...icrosoft-onedrive-connector-reference.adoc | 1410 +++++++++++++++++ 4 files changed, 1484 insertions(+) create mode 100644 microsoft-onedrive/1.2/antora.yml create mode 100644 microsoft-onedrive/1.2/modules/ROOT/nav.adoc create mode 100644 microsoft-onedrive/1.2/modules/ROOT/pages/index.adoc create mode 100644 microsoft-onedrive/1.2/modules/ROOT/pages/microsoft-onedrive-connector-reference.adoc diff --git a/microsoft-onedrive/1.2/antora.yml b/microsoft-onedrive/1.2/antora.yml new file mode 100644 index 0000000000..db5d9e8201 --- /dev/null +++ b/microsoft-onedrive/1.2/antora.yml @@ -0,0 +1,18 @@ +name: microsoft-onedrive-connector +version: '1.2' +display_version: 1.2 (Mule 4) +title: Microsoft OneDrive Connector +nav: +- modules/ROOT/nav.adoc +asciidoc: + attributes: + page-component-desc: Enables access to the most commonly used operations provided by the Microsoft Graph APIs. + page-connector-type: Connector + page-connector-level: Select + page-exchange-group-id: com.mulesoft.connectors + page-exchange-asset-id: mule4-microsoft-onedrive-connector + page-runtime-version: 4.2.1 + page-release-notes-page: release-notes::connector/microsoft-onedrive-connector-release-notes-mule-4.adoc + page-vendor-name: microsoft + page-vendor-title: Microsoft + page-notice-banner-message: Standard support for Java 8 and 11 ends in August 2026 for 4.6 LTS. Plan your upgrade path for apps that are running on Java 8 or 11 accordingly. diff --git a/microsoft-onedrive/1.2/modules/ROOT/nav.adoc b/microsoft-onedrive/1.2/modules/ROOT/nav.adoc new file mode 100644 index 0000000000..5f69507b0e --- /dev/null +++ b/microsoft-onedrive/1.2/modules/ROOT/nav.adoc @@ -0,0 +1,3 @@ +.xref:index.adoc[Microsoft OneDrive Connector] +* xref:index.adoc[Microsoft OneDrive Connector Overview] +* xref:microsoft-onedrive-connector-reference.adoc[Microsoft OneDrive Connector Reference] diff --git a/microsoft-onedrive/1.2/modules/ROOT/pages/index.adoc b/microsoft-onedrive/1.2/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000000..9064f015e7 --- /dev/null +++ b/microsoft-onedrive/1.2/modules/ROOT/pages/index.adoc @@ -0,0 +1,53 @@ += Microsoft OneDrive Connector 1.2 + + + +Anypoint Connector for Microsoft OneDrive (OneDrive Connector) enables you to access Microsoft Graph APIs to provide a unified programmability model that you can use to access the tremendous amount of data in Microsoft 365, Windows 10, and Enterprise Mobility + Security. + +For compatibility information and fixed issues, see the Microsoft OneDrive Connector Release Notes. + +== Before You Begin + +To use this connector, you must be familiar with: + +* Microsoft Graph API 1.0 +* Anypoint Connectors +* Mule runtime engine (Mule) +* Elements and global elements in a Mule flow +* Creating a Mule app using Anypoint Studio or Anypoint Code Builder + +Before creating an app, you must have: + +* Credentials to access the target resource +* Anypoint Studio or Anypoint Code Builder + +== Common Use Cases for the Connector + +Some common use cases for OneDrive Connector include: + +* Sales Operations +** When a sales contract comes in through the Salesforce CRM system, upload the contract to OneDrive and collaboratively review the contract with the Deal Desk. You can assign approval tasks to notify the contract owner when a contract is approved or rejected. +** When a new budget proposal or customer invoice is generated, upload the documents to OneDrive and collaborate with the accounting team for their review. You can assign tasks to notify the invoice owner when an invoice is approved or rejected. +** When an opportunity is closed (won), create a folder structure in OneDrive based on a predefined template. +* Employee onboarding and offboarding +** When new employees start their jobs, existing resources can be shared with them via OneDrive. +** Create a new folder in OneDrive and share it with the new employee so they can upload documents to it. +** After an employee leaves the company, all documents used or uploaded can be moved or deleted (GDPR). +* Health care + +Share sensitive patient data with the departments that are allowed to access the information by using OneDrive to share the files, and allow access to the relevant parties. + + +== Authentication Types + +OneDrive Connector uses the following authentication methods: + +* OAuth 2.0 authorization code grant connection type, which is used in applications that are installed on a device to gain access to protected resources. +* OAuth 2.0 client credentials grant, which uses the identity of the application to access web-hosted resources. + + +== See Also + +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +* xref:connectors::introduction/intro-use-exchange.adoc[Use Exchange to Discover Connectors, Templates, and Examples] +* xref:microsoft-onedrive-connector-reference.adoc[Microsoft OneDrive Connector Reference] +* https://help.salesforce.com[Salesforce Help] diff --git a/microsoft-onedrive/1.2/modules/ROOT/pages/microsoft-onedrive-connector-reference.adoc b/microsoft-onedrive/1.2/modules/ROOT/pages/microsoft-onedrive-connector-reference.adoc new file mode 100644 index 0000000000..c709ff19cc --- /dev/null +++ b/microsoft-onedrive/1.2/modules/ROOT/pages/microsoft-onedrive-connector-reference.adoc @@ -0,0 +1,1410 @@ += Microsoft OneDrive Connector 1.2 Reference + +Anypoint Connector for Microsoft OneDrive (OneDrive Connector) enables you to access Microsoft Graph APIs. + +[[OnedriveConfig]] +== Microsoft OneDrive Config + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +|Name | String | Name for this configuration. Connectors reference the configuration with this name. | | x +| Connection a| * <> +* <> + | The connection types to provide to this configuration. | | x +| Drive ID a| String | Drive ID to use across all operations unless overwritten by the operation parameter. | | +| Name a| String | Identifier of the element used by other components for reference. | | x +| Expiration Policy a| <> | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | | +| Read Timeout a| Number | Specifies the amount of time in milliseconds that the consumer waits for a response before it times out. | 60 | +| Read Timeout Time unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout Time Unit* field. | SECONDS | +|=== + +=== Connection Types + +[[OnedriveConfig_OauthAuthorizationCode]] +==== OAuth v2.0 Authorization Code + +include::connectors::partial$oauth2-description.adoc[] + +===== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy configuration a| <> | Proxy configuration for the connector. | | +| Base Url a| String | Base URL for Microsoft Graph endpoints to access from the connector and from which all other endpoints are derived. | `\https://graph.microsoft.com/v1.0` | +| Response Type a| String | Specifies the method to use to send the resulting token back to your app. This must be `query`. | query | +| TLS configuration a| <> | Configures TLS. If using the HTTPS protocol, you must configure TLS. | | +| Reconnection a| <> | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn't pass after exhausting the associated reconnection strategy. | | +| Consumer Key a| String | The OAuth consumerKey as registered with the service provider. | | x +| Consumer Secret a| String | The OAuth consumerSecret as registered with the service provider | | x +| Authorization Url a| String | The service provider's authorization endpoint URL. | `+https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize+` | +| Access Token Url a| String | The service provider's accessToken endpoint URL. | `+https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token+` | +| Scopes a| String | The OAuth scopes to request during the OAuth dance. If not provided, it defaults to the OAuth scopes in the annotation. | | +| Resource Owner Id a| String | The resource owner ID for each component to use if it is not otherwise referenced. | | +| Before a| String | Name of the flow to execute immediately before starting the OAuth dance. | | +| After a| String | Name of the flow to execute immediately after an access token is received. | | +| Listener Config a| String | Configuration for the HTTP listener that listens for requests on the access token callback endpoint. | | x +| Callback Path a| String | Path of the access token callback endpoint. | | x +| Authorize Path a| String | Path of the local HTTP endpoint that triggers the OAuth dance. | | x +| External Callback Url a| String | URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL. | | +| Object Store a| String | Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store. | | +|=== + +[[OnedriveConfig_OauthClientCredentials]] +==== OAuth v2.0 Client Credentials + +Access web-hosted resources by using the identity of the application. + +===== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy configuration a| <> | Proxy configuration for the connector. | | +| Base Url a| String | Base URL for Microsoft Graph endpoints to access from the connector and from which all other endpoints are derived. | `\https://graph.microsoft.com/v1.0` | +| TLS configuration a| <> | Configures TLS. If using the HTTPS protocol, you must configure TLS. | | +| Reconnection a| <> | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn't pass after exhausting the associated reconnection strategy. | | +| Client Id a| String | The OAuth client ID as registered with the service provider. | | x +| Client Secret a| String | The OAuth client secret as registered with the service provider. | | x +| Token Url a| String | The service provider's token endpoint URL. | `+https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token+` | +| Scopes a| String | The OAuth scopes to request during the OAuth dance. If not provided, it defaults to the OAuth scopes in the annotation. | | +| Object Store a| String | Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store. | | +|=== + +== Operations + +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> + + +[[AddPermission]] +== Add Permission +`` + +Gives read or write access to a specified file for users that are specified in the *Permissions Info* field. + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| DriveItem ID a| String | ID of the drive driveItem to which to add this permission. | | x +| Permissions Info a| Any | Information about the permission to add. | #[payload] | +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve a list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate a driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| Binary +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[CopyDriveItem]] +== Copy Drive Item +`` + +Executes a copy request to Microsoft OneDrive. + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| DriveItem ID a| String | ID of the driveItem to copy. | | x +| Parent DriveItem ID a| String | ID of the folder to copy the selected driveItem to. If unspecified, the selected file is copied to the same folder in which it resides. | | +| Conflict name a| String | In case of conflict, specifies a new name for the drive item after the copy operation is completed. | | +| Read Timeout a| Number | Read timeout value. Used to override the Read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve the list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate a driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | An expression to evaluate against the operation's output and store the expression outcome in the target variable | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| Binary +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[CreateDriveItem]] +== Create Drive Item +`` + +Creates a new driveItem entity type in the specified OneDrive. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | The name of the configuration to use. | | x +| Parent DriveItem ID a| String | ID of the folder to copy the selected driveItem to. | | x +| Drive Item name a| String | Name to use when creating the file. | | x +| DriveItem Type a| Enumeration, one of: + +** FOLDER +** FILE | The type of driveItem to create, which can be either FILE or FOLDER | FILE | +| Conflict behavior a| Enumeration, one of: + +** RENAME +** REPLACE +** FAIL | Specifies what happens in case of a name conflict. Possible values are: FAIL, RENAME, REPLACE | FAIL | +| Item properties a| Object a| Additional properties to add to the file. + +Use the *Item properties* field for https://learn.microsoft.com/en-us/graph/api/resources/folder?view=graph-rest-1.0[folder] or https://learn.microsoft.com/en-us/graph/api/resources/file?view=graph-rest-1.0[file] metadata settings. The following example shows the *Item properties* field for folder metadata settings: + +---- +output application/json +--- +{ +"childCount": 1024, +"view": { "@odata.type": "microsoft.graph.folderView" } +} +---- + +The result request to Microsoft OneDrive is: + +---- +{ +"name":"New Folder", +"folder": { +"childCount": 1024, +"view":{"@odata.type":"microsoft.graph.folderView"} +}, +"@microsoft.graph.conflictBehavior":"rename" +} +---- + +| | +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | The time unit value used by the read timeout | | +| Config Ref a| ConfigurationProvider | The name of the configuration to use to execute this component | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve the list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate a driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| Binary +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[CreateSharingLink]] +== Create Sharing Link +`` + +Creates a new sharing link. If a sharing link of the specified type already exists for the app, the existing sharing link is returned. + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| DriveItem ID a| String | ID of the driveItem for which to create the sharing link. | | x +| Link Type a| Enumeration, one of: + +** VIEW +** EDIT | Type of sharing link to create. Accepted values are `view` or `edit`. A value of `view` creates a read-only link to the driveItem. A value of `edit` creates a read-write link to the driveItem. | | x +| Scope Type a| Enumeration, one of: + +** ANONYMOUS +** ORGANIZATION | The scope of the link to create. Accepted values are `anonymous` and `organization`. A value of `anonymous` indicates the link is usable by anyone. A value of `organization` indicates the link is only usable for users who are signed in to the same tenant. | | +| Expiration Date Time a| String | Indicates the expiration time of the permission, specified as a string with a format of `yyyy-MM-ddTHH:mm:ssZ` for DateTime. | | +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve a list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate a driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| Binary +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[DeleteDriveItem]] +== Delete Drive Item +`` + +Deletes a driveItem based on the specified ID. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| DriveItem ID a| String | ID of the driveItem to delete. | | x +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve a list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate a driveItem. | | +| Reconnection Strategy a| * <> +* <> | Retry strategy in case of connectivity errors. | | +|=== + + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[GetDriveItemById]] +== Get Drive Item By Id +`` + + +Retrieves information about the a driveItem based on the specified ID. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| DriveItem ID a| String | ID of the driveItem to retrieve. | | x +| Select a| String | Properties to retrieve in the response. | | +| Expand a| String | The response includes information about the specified relationship. | | +| Advanced Query Params a| Object | Additional OData queries that are not exposed as specific parameters. | | +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve the list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate a driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| Binary +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[GetDriveItemByPath]] +== Get Drive Item By Path +`` + + +Retrieves information about a driveItem based on the specified path. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| DriveItem Path a| String | Path of the driveItem to retrieve. | | x +| Select a| String | Properties to retrieve in the response. | | +| Expand a| String | The response will include information about the specified relationship. | | +| Advanced Query Params a| Object | Additional OData queries that are not exposed as specific parameters. | | +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve the list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate a driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| Binary +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[GetRoot]] +== Get Root +`` + +Retrieves information about the root folder of a drive. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Select a| String | Properties to retrieve in the response. | | +| Expand a| String | The response will include information about the specified relationship. | | +| Advanced Query Params a| Object | Additional OData queries that are not exposed as specific parameters. | | +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve the list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate a driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| Binary +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[ListChildren]] +== List Children +`` + +Retrieves a collection of driveItems from the driveItem's child relationships. + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Folder ID a| String | ID of the folder from which to extract the list of children. | | x +| Select a| String | Properties to retrieve in the response. | | +| Expand a| String | The response will include information about the specified relationship. | | +| Order By a| String | Parameter used to specify the sort order of the items returned. | | +| Advanced Query Params a| Object | Additional OData queries that are not exposed as specific parameters. | | +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-iterable | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve the list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate a driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Array of Object +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[ListPermissions]] +== List Permissions +`` + + +Retrieves a collection of permissions resources on a driveItem. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| DriveItem ID a| String | The ID of the driveItem. | | x +| Select a| String | Properties to retrieve in the response. | | +| Advanced Query Params a| Object | Additional OData queries that are not exposed as specific parameters. | | +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve the list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate a driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| Binary +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[MonitorRequest]] +== Monitor Request +`` + + +Retrieves information about an async request. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| URL a| String | Location of the URL to query. | | x +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| Binary +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[MoveDriveItem]] +== Move Drive Item +`` + + +Executes a move request to Microsoft OneDrive. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| DriveItem ID a| String | ID of the driveItem to move. | | x +| Parent DriveItem ID a| String | ID of the folder to which to move the driveItem. | | +| New DriveItem name a| String | New name for the driveItem after it is moved. | | +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve the list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate the driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| Binary +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[RemovePermission]] +== Remove Permission +`` + + +Removes access to a driveItem. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| DriveItem ID a| String | ID of the driveItem. | | x +| Permission Id a| String | ID of the permission to remove. | | x +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve the list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate the driveItem. | | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + +[[Unauthorize]] +== Unauthorize +`` + + +Deletes all the access token information of a given resource owner ID so that it's impossible to execute any operation for that user without first repeating the authorization dance. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Resource Owner Id a| String | ID of the resource owner for whom to invalidate access. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +|=== + + +=== For Configurations + +* <> + + + +[[UploadContent]] +== Upload Content +`` + + +Uploads content of one file into another file in OneDrive. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| File ID a| String | ID of the file to which to upload the content. | | x +| Content a| Any | Content to upload. | #[payload] | +| Size a| Number | Size of the content in bytes. | | x +| Preferred Request Size a| Number | Preferred request size in megabytes. Minimum is 1 MB. Maximum is 60 MB. | 10 | +| Read Timeout a| Number | Read timeout value. Used to override the read timeout values defined in the connector configuration. | | +| Read Timeout Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit value for the *Read Timeout* field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. The default is to use repeatable streams. | | +| Location a| Enumeration, one of: + +** GROUP +** USER | Location from which to retrieve the list of drive IDs. | | +| Entity ID a| String a| ID of the entity to use to retrieve the list of drives. + +[NOTE] +The *Entity ID* is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group. + +| | +| Drive ID a| String | Drive ID used to locate the driveItem. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Reconnection Strategy a| * <> +* <> | A retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Any +|=== + +=== For Configurations + +* <> + +=== Throws + +* MICROSOFTONEDRIVE:BAD_REQUEST +* MICROSOFTONEDRIVE:CONFLICT +* MICROSOFTONEDRIVE:CONNECTIVITY +* MICROSOFTONEDRIVE:FORBIDDEN +* MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE +* MICROSOFTONEDRIVE:INVALID_CONNECTION +* MICROSOFTONEDRIVE:INVALID_INPUT +* MICROSOFTONEDRIVE:LOCKED +* MICROSOFTONEDRIVE:NOT_FOUND +* MICROSOFTONEDRIVE:RETRY_EXHAUSTED +* MICROSOFTONEDRIVE:SERVER_ERROR +* MICROSOFTONEDRIVE:TIMEOUT +* MICROSOFTONEDRIVE:TOO_MANY_REQUESTS +* MICROSOFTONEDRIVE:UNAUTHORIZED + + + +== Types +[[ProxyConfiguration]] +=== Proxy Configuration + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Host a| String | Host where the proxy requests are sent. | | x +| Port a| Number | Port where the proxy requests are sent. | | x +| Username a| String | The username to authenticate against the proxy. | | +| Password a| String | The password to authenticate against the proxy. | | +|=== + +[[Tls]] +=== Tls + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Enabled Protocols a| String | A comma-separated list of protocols enabled for this context. | | +| Enabled Cipher Suites a| String | A comma-separated list of cipher suites enabled for this context. | | +| Trust Store a| <> | | | +| Key Store a| <> | | | +| Revocation Check a| * <> +* <> +* <> | | | +|=== + +[[TrustStore]] +=== Trust Store + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Path a| String | The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore. | | +| Password a| String | Password used to protect the truststore. | | +| Type a| String | Type of truststore used. | | +| Algorithm a| String | The algorithm used by the truststore. | | +| Insecure a| Boolean | If `true`, Mule stops performing certificate validations. This can make connections vulnerable to attacks. | | +|=== + +[[KeyStore]] +=== Key Store + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Path a| String | The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore. | | +| Type a| String | The type of store used. | | +| Alias a| String | When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default. | | +| Key Password a| String | Password used to protect the private key. | | +| Password a| String | Password used to protect the keystore. | | +| Algorithm a| String | Algorithm used by the keystore. | | +|=== + +[[StandardRevocationCheck]] +=== Standard Revocation Check + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Only End Entities a| Boolean | Only verify the last element of the certificate chain. | | +| Prefer Crls a| Boolean | Try CRL instead of OCSP first. | | +| No Fallback a| Boolean | Do not use the secondary checking method (the one not previously selected). | | +| Soft Fail a| Boolean | Avoid verification failure when the revocation server cannot be reached or is busy. | | +|=== + +[[CustomOcspResponder]] +=== Custom OCSP Responder + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Url a| String | The URL of the OCSP responder. | | +| Cert Alias a| String | Alias of the signing certificate for the OCSP response (must be in the truststore), if present. | | +|=== + +[[CrlFile]] +=== CRL File + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Path a| String | The path to the CRL file. | | +|=== + +[[Reconnection]] +=== Reconnection + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Fails Deployment a| Boolean | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn't pass after exhausting the associated reconnection strategy. | | +| Reconnection Strategy a| * <> +* <> | The reconnection strategy to use. | | +|=== + +[[Reconnect]] +=== Reconnect + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Frequency a| Number | How often in milliseconds to reconnect. | | +| Blocking a| Boolean | If false, the reconnection strategy will run in a separate, non-blocking thread. | | +| Count a| Number | How many reconnection attempts to make. | | +|=== + +[[ReconnectForever]] +=== Reconnect Forever + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Frequency a| Number | How often in milliseconds to reconnect. | | +| Blocking a| Boolean | If false, the reconnection strategy will run in a separate, non-blocking thread. | | +|=== + +[[ExpirationPolicy]] +=== Expiration Policy + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Max Idle Time a| Number | A scalar time value for the maximum amount of time a dynamic configuration instance can be idle before it's considered eligible for expiration. | | +| Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Max Idle Time* field. | | +|=== + +[[RepeatableInMemoryStream]] +=== Repeatable In Memory Stream + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Initial Buffer Size a| Number | Initial amount of memory to allocate to the memory stream. If the stream data exceeds this value, the buffer expands by *Buffer Size Increment*, with an upper limit of *Max In Memory Size value*. | | +| Buffer Size Increment a| Number | Amount by which the buffer size expands if it exceeds its initial size. Setting a value of `0` or lower specifies that the buffer can't expand. | | +| Max Buffer Size a| Number | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | | +| Buffer Unit a| Enumeration, one of: + +** BYTE +** KB +** MB +** GB | The unit in which all these attributes are expressed. | | +|=== + +[[RepeatableFileStoreStream]] +=== Repeatable File Store Stream + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| In Memory Size a| Number | Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. | | +| Buffer Unit a| Enumeration, one of: + +** BYTE +** KB +** MB +** GB | The unit in which maxInMemorySize is expressed. | | +|=== + +[[RepeatableInMemoryIterable]] +=== Repeatable In Memory Iterable + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Initial Buffer Size a| Number | The number of instances that are initially allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. | | +| Buffer Size Increment a| Number | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. | | +| Max Buffer Size a| Number | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | | +|=== + +[[RepeatableFileStoreIterable]] +=== Repeatable File Store Iterable + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| In Memory Objects a| Number | The maximum number of instances to keep in memory. If more than that is required, content on the disk is buffered. | | +| Buffer Unit a| Enumeration, one of: + +** BYTE +** KB +** MB +** GB | The unit in which maxInMemorySize is expressed. | | +|=== + +== See Also + +* xref:index.adoc[Microsoft OneDrive Connector Overview] +* https://help.salesforce.com[Salesforce Help]