In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Use this account type to connect <Snap Pack name> Exchange Online Snaps with data sources that use <Account Type Name> accounts.
Prerequisites
...
use Exchange Online OAuth2 User accounts. The Exchange Online OAuth2 User Account has limited user permissions as you do not require all the permissions in the Microsoft Azure Portal. The User Account is typically used when an individual user needs access to the Exchange Online mailbox. This method allows the application or service to interact with the user's Exchange Online mailbox on their behalf. Refer to this example to know when to use the Exchange Online OAuth2 User Account.
Prerequisites
Valid Azure application in Azure portal with the required API permissions.
Limitations and Known Issues
...
None.
...
Account Settings
...
| title | Documenting Fields Based On Data Type/UI Element |
|---|
**Delete Before Publishing**
Choose from the following sentences to document specific field types.
...
- <State what the field contains>. Available options are: <bullet list of LoVs>
The Salesforce API to be used. Available options are:... - Select the <category> that you want to use. Available options are...
* Option 1<italicized>: <third person singular form of the verb>
* Option 2<italicized>: <third person singular form of the verb>
Select the API that you want to use. Available options are:
Bulk API: Sends the Snap execution request details as a bulk API call.
REST API: ... - Indicates.... Available options are:
Indicates how the Snap must be executed. Available options are:
* Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.
* Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.
* Disabled: Disables the Snap and, by extension, its downstream Snaps.
Check boxes:
- If selected, <Snap behavior>.
If selected, an empty file is written when the incoming document has no data. - If selected, <behavior>. If not selected/Otherwise, <behavior>
Use "If not selected" if the first sentence is long.
If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.
- Select to <action>
Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
Select to execute the Pipeline during validation.
Text Fields
- Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
The name of the account.
The account ID that you want to use to log in to the endpoint.
Required if IAM Role is selected.
Do not use this field if you are using batch processing.
Numeric Text Fields
- Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
The number of records in a batch.
The number of seconds for which you want the Snap to wait between retries.
The number of seconds for which the Snap waits between retries.
Use the following special values:
* 0: Disables batching.
* 1: Includes all documents in a single request.
...
Required. Unique user-provided label for the account.
...
Account Settings
...
| Info |
|---|
|
Field | Field Type | Description | |
|---|---|---|---|
Label*
| String | Specify a unique name for the account. | |
Client ID*
| String | Specify the client ID associated with your Azure application. You can create the client ID as advised by your application provider. Learn more about how to generate Client ID: Application Configuration in Azure Portal for OAuth2 Account to use in Exchange Online | |
Client secret*
| String | Specify the client secret associated with your account. You can create the client secret as advised by your application provider. Learn more about how to generate Client Secret: Application Configuration in Azure Portal for OAuth2 Account to use in Exchange Online | |
Access token
| String | Auto-generated after authorization. | |
Refresh token
| String | Auto-generated after authorization. | |
Access token expiration
| Integer | Auto-generated after authorization. Specify the duration till which the access token remains active. | |
OAuth2 Endpoint*
| String | Specify the authorization endpoint to authorize the application. Replace tenant ID placeholder with the tenant ID generated while creating OAuth2 application. | |
OAuth2 Token*
| String | Specify the token endpoint to get the access token. Replace tenant ID placeholder with the tenant ID generated while creating OAuth2 application. | |
Token endpoint config | Use this field set to provide custom properties for the OAuth2 token endpoint. | ||
Token endpoint parameter
| String | Defines an optional token endpoint parameter value. | |
Token endpoint parameter value
| String | Provides custom properties for the OAuth2 auth endpoint. | |
Auth endpoint config | Use this field set to provide custom properties for the OAuth2 auth endpoint. | ||
Auth endpoint parameter
| String | Specify the name of the endpoint authentication parameter. | |
Auth endpoint value
| String | Specify the value corresponding to the endpoint authentication parameter. | |
Troubleshooting
...
Error | Reason | Resolution |
|---|
Authentication failed |
The Pipeline ended before the batch could complete execution due to a connection error.
Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.
See Also
. | You have entered an incorrect Client ID or Client secret. | Check and ensure that you have provided the correct and valid Client ID and Client secret for the account and allowed the required access privileges to the application. |
Error in Authorization: Something went wrong when authorizing this app. Invalid client_id parameter. | You have entered an incorrect Client ID. | Check and correct the Client ID entered for the account and try authorizing the app again. |
Snap Pack History
| Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...