In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
...
Use this account type to connect <Snap Pack name> Microsoft Teams Snaps with data sources that use <Account Type Name> OAuth2 application accounts.
Prerequisites
...
A registered application in the Microsoft Azure Portal with appropriate permissions that contains the following information.
- Client ID
- Tenant name or Tenant ID
- Client secret
- Access token
- OAuth 2.0 authorization endpoint
- OAuth 2.0 token endpoint
- Token endpoint configuration
- Auth endpoint configuration
Limitations
None.
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.
...
Troubleshooting
Account validation failed
The Pipeline ended before the batch could complete execution due to a connection error.
| Parameter | Data Type | Description | Default Value | Example | |||||
|---|---|---|---|---|---|---|---|---|---|
Label | String | Required. Enter a unique label for the account. | N/A | MSTeams_Docs_App_Account | |||||
Client ID | String | Required. Enter the client ID associated with your Azure application. You can create the client ID as advised by your application provider. | N/A | 1abcd23e-45fg-6789-hi01-23456jk789l0 | |||||
Client secret | String | Enter the client secret associated with your account. You can create the client secret as advised by your application provider. | N/A | bec1f9242f9nsh67f2276b9ws4cadd14 | |||||
Access token | String | Auto-generated upon account authorization. The access token associated with the Azure portal application is used to make API requests on behalf of the user associated with the client ID. | N/A | N/A | |||||
| Refresh token | String | Auto-generated upon account authorization. The token used to refresh the access token. | N/A | N/A | |||||
Access token expiration | Integer | Auto-generated upon account authorization. The access token expiration value. | N/A | ||||||
| OAuth2 Endpoint | URL | Required. Enter the tenant ID in the designated position in the URL. | https://login.microsoftonline.com/ <tenant_id>/oauth2/v2.0/authorize | https://login.microsoftonline.com/123a456b-7c89-0d1e-234f-g5h678901ijk/oauth2/v2.0/authorize | |||||
OAuth2 Token | URL | Required. Enter the tenant ID in the designated position in the URL. | https://login.microsoftonline.com/ <tenant_id>/oauth2/v2.0/token | https://login.microsoftonline.com/123a456b-7c89-0d1e-234f-g5h678901ijk/oauth2/v2.0/token | |||||
Token endpoint config | Use this field set to configure token endpoint parameters as necessary for the account. This field set comprises the following fields:
Click the + or - icons to respectively add or remove configuration rows.
| ||||||||
Token endpoint parameter | String | Provide the name for the token endpoint parameter. | N/A | scope | |||||
Token endpoint parameter value | String | Provide the value for the parameter, typically the default scope or a redirect_uri. See Scopes and permissions required for OneDrive API. | N/A | offline_access Files.ReadWrite.All Sites.ReadWrite.All | |||||
| Auth endpoint config | Use this field set to configure auth endpoint parameters as necessary for the account. This field set comprises the following fields:
Click the + or - icons to respectively add or remove configuration rows.
| ||||||||
| Auth endpoint parameter | String | Provide the name for the auth endpoint parameter. | N/A | scope | |||||
| Auth endpoint parameter value | String | Provide the value for the parameter, typically the default scope or a redirect_uri. See Scopes and permissions required for OneDrive API. | N/A | offline_access Files.ReadWrite.All Sites.ReadWrite.All | |||||
| Auto-refresh token | Checkbox | Select this to refresh the access token automatically. | Not selected | Selected | |||||
| Authorize | Button | Click this button to acquire the required permissions for this account from the Azure portal app, when creating an account. For existing accounts, you can click this button to re-acquire the permissions to ensure that the account works as expected. This action does not require or result in any changes to the Access Token that is already generated. | N/A | N/A | |||||
| Refresh | Button | Click this button to refresh the access token using the refresh token. | N/A | N/A | |||||
Troubleshooting
None.
...