Versions Compared

Key

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

In this article

...

Field Name

Field Type

Description

Label*

Default Value: N/A
Example: SharePoint Online Account

String

Specify a unique label for the account.

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 ID as advised by your application provider. Learn more about generating the Client ID.

Client secret*

Default Value: N/A
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.

Access token*

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

String

Specify the access token for the 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.

Access token expiration

Default Value: N/A
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/contoso.onmicrosoft.com/oauth2/v2.0/authorize

String

Specify the authorization endpoint to authorize the application in the following format:

https://login.microsoftonline.com/<tenantName>.onmicrosoft.com/oauth2/v2.0/authorize

You can consider the URL provided by the endpoint documentation
(Microsoft), and replace the <tenantID> with the <tenantName>

.

  • You must use <tenantName>.onmicrosoft.com instead of <tenantName>.sharepoint.com in the OAuth2 Endpoint URL.

  • Steps to obtain the tenantName from the Azure portal:

    1. Log in to the Azure Portal.

    2. Navigate to Azure Entra ID.

    3. Under the Overview section, the Primary Domain Name is the <tenantName>, which must be used as <tenantName>.onmicrosoft.com in the OAuth2 Endpoint URL.

    If you are using the URL (https://login.microsoftonline.com/<tenantid>/oauth2/v2.0/authorize) to configure the OAuth2 Endpoint in your SharePoint Online Account, ensure that you replace <tenantID> with <tenantName>.onmicrosoft.com

    OAuth2 Token*

    Default Value: https://login.microsoftonline.com/<tenantName>.onmicrosoft.com/oauth2/v2.0/token
    Example:https://login.microsoftonline.com/contoso.onmicrosoft.com/oauth2/v2.0/token

    String

    Specify the token endpoint to get the access token in the following format:

    https://login.microsoftonline.com/<tenantName>.onmicrosoft.com/oauth2/v2.0/token

    You can consider the URL provided by the endpoint documentation (Microsoft), and replace the <tenantID> with the <tenantName>.

    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.

    Token endpoint parameter

    Default Value: N/A
    Example: response_type

    String

    Define optional token endpoint parameter.

    Token endpoint parameter value

    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.

    Auth endpoint parameter

    Default Value: N/A
    Example: scope

    String

    Define optional authentication 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

    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.

    ...