Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

Use this account type to connect SharePoint online Snaps that use SharePoint Online User Account.

Prerequisites

  • Valid Azure application with all the required API permissions.

  • Valid client ID and client secret.

Limitations and Known Issues

None.

Account Settings

Image Removed

...

Label

...

String

...

...

Info
  • Asterisk ( * ): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ((blue star)): Indicates that you can add fields in the field set.

  • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

Required. The client

Field Name

Field Type

Description

Label*

Default Value: N/A
Example: SharePoint Online Account

String

Specify a unique label for the account.

None

Sharepoint online OAuth2 Dev

Client ID

String

Client ID*

Default Value: N/A
Example: c3fb6e88-9ec0-468f-ba06-cc94525a8f1d

String

Specify the Client ID associated with your Azure application. You can create the

client

Client secret

StringRequired. The client

Client ID as advised by your application provider. Learn more about generating the Client ID.

Client secret*

Default Value: N/A

c3fb6e88-9ec0-468f-ba06-cc94525a8f1d

Example: <Value is encrypted>

String

Specify the Client secret associated with your account. You can create the client secret as advised by your application provider. Learn more about generating the Client secret.

N/A

Access token*

Default Value: N/A

Access token The

Example: <Value is encrypted>

String

Required. Auto-generated after authorization.

Specify the access token

associated with

for the

Azure application is used to make API requests on behalf of the user associated with the client ID.N/AN/A

Refresh token

StringRequired. The refresh token retrieval for the application is specified

application. The retrieval of the access token is done when setting up the account for the endpoint.

Refresh token*

Default Value: N/A
Example: <Value is encrypted>

String

Specify the refresh token for the application. The retrieval of the refresh token is done when setting up the account for the endpoint.

There, the OAuth2 flow will be executed and the resulting refresh token can be stored in this property. If the refresh token is stored, then the access token can be refreshed automatically before it expires.

Access token expiration

Default Value: N/A

N/A

Access token expiration

IntegerThe access token expiration value.N/AN/A

Header authenticated

Checkbox

Enable this if endpoint uses bearer header authentication.

Not selected

OAuth2 Endpoint

String

Required. Authorization endpoint to authorize the application.

Example: 1629004558

Integer

Specify the time until which the access token should be active.

OAuth2 Endpoint

Default Value: https://login.microsoftonline.com/<tenantName>.onmicrosoft.com/oauth2/v2.0/authorize
Example: https://login.microsoftonline.com/3164ebb4-0b34-42ff-820b-25c39783105f/oauth2/v2.0/authorize

String

Specify the authorization endpoint to authorize the application.

https://login.microsoftonline.com/<tenant-id*>/oauth2/v2.0/authorize

OAuth2 Token*

Default Value: https://login.microsoftonline.com/

<tenantName>

{tenantName}.onmicrosoft.com/oauth2/v2.0/

authorize

OAuth2 Token

StringRequired. Token

token
Example: https://login.microsoftonline.com/3164ebb4-0b34-42ff-820b-25c39783105f/oauth2/v2.0/token

String

Specify the token endpoint to get the access token.

https://login.microsoftonline.com/

{tenantName}.onmicrosoft.com

<tenant-id*>/oauth2/v2.0/token

N/A

Token endpoint config

Use this fieldset to provide custom properties for the OAuth2 token endpoint. Click the + or - icons to respectively add or remove configuration rows.

This fieldset comprises the following fields:

Token endpoint parameter

  • Token endpoint parameter value
  • Token endpoint parameter

    Default Value: N/A
    Example: response_type

    String

    Defines an

    Define optional token endpoint parameter

    value

    .

    N/Aresponse_type

    Token endpoint parameter value

    String

    Provides custom properties for the OAuth2 auth endpoint.

    Auth endpoint parameter

    String

    Defines an optional authentication parameter.

    Default Value: N/A
    Example: code

    String

    Define optional token endpoint parameter value.

    Auth endpoint config

    Use this field set to provide custom properties for the OAuth2 auth endpoint. Click the + or - icons to respectively add or remove configuration rows.

    This field set comprises the following fields:

    • Auth endpoint parameter
    • Auth endpoint value

    Auth endpoint parameter

    Default Value: N/A
    Example: scope

    Auth endpoint value

    String

    Defines an

    Define optional authentication

    parameter value

    parameters.

    Auth endpoint value

    Default Value: N/A
    Example: offline_access Sites.ReadWrite.All

    String

    Define optional authentication parameter values.

    Auto-refresh token

    Default Value: Deselected

    Checkbox

    Refreshes

    Select to refresh the token automatically using the refresh token if the property is enabled. Otherwise, the token might expire and will not be automatically refreshed.

    DisabledN/A

    Troubleshooting

    Error

    Reason

    Resolution

    Authentication failed.

    You have entered an incorrect client-id or client-secret.

    Check your client-id and client-secret. 

    Snap Pack History

    Expand

    Insert excerpt
    SharePoint Online Snap Pack
    SharePoint Online Snap Pack
    nameSharePoint Online SPH
    nopaneltrue

    ...

    See Also

    ...

    ...