Label*

Default Value: None
Example: HTTP Client OAuth2 Account

String

Specify a unique label for the account.

Client ID*

Default Value: N/A
Example: bcptk3dmg19btc1ahofqw5bhzrhg

String

Specify the OAuth Client ID associated with your account. You can create the client ID as advised by your application provider.

Client secret

Default Value: N/A
Example: jhktz@wld*(687 

String

Specify the OAuth Client secret associated with your account.

Send client data as Basic Auth header

Default Value: Deselected

Checkbox

Select this checkbox to pass the client data as part of the Basic Auth header when generating a token.

Access token

Default Value: N/A
Example: <Encrypted>

String

Autogenerated on account authorization. The access token is used to make API requests on behalf of the user associated with the client ID.

Refresh token

Default Value: N/A
Example: <Encrypted>

String

Autogenerated after authorization. Specify the refresh token associated with your account. If the refresh token is stored, then the access token can be refreshed automatically before it expires.

You should retrieve the Refresh token when setting up the account for the endpoint, where the OAuth2 flow is executed and the resulting refresh token is stored in this field. If the refresh token is stored, then the access token can be refreshed automatically before it expires. 

Access token expiration

Default Value: Current Time + 3600 seconds
Example: 1663659049

Integer

Autogenerated on account authorization. The number of seconds after which the access token expires.

Header authenticated

Default Value: Deselected

Checkbox

Select this checkbox if the endpoint uses bearer header authentication.

OAuth2 Endpoint*

Default Value: N/A
Example: https://www.box.com/api/oauth2/authorize

String

Specify the URL of the endpoint that authorizes the application. 

OAuth2 Token*

Default Value: N/A
Example: https://www.box.com/api/oauth2/token

String

Specify the URL of the endpoint that retrieves the token for an authenticated account.

Grant Type

Default Value: authorization_code
Example: authorization_code

Dropdown

Select the method of authorization.

• Authorization Code: The user account is authenticated using credentials (username and password), which return to the client through a redirect URL. The application then receives the authorization code from the URL and uses it to request an access token.

• Client Credentials: Obtains an access token for the client ID and client secret through the token endpoint URL.

• Password: Obtains an access token using your log-in credentials (username and password). When selected, it populates the following fields:

  • Username: Specify the username of the account type.

  • Password: Specify the password of the account type.

Token endpoint config

Use this field set to define custom properties for the OAuth2 token endpoint. This endpoint returns access tokens or refresh tokens depending on the request parameters.

Token endpoint parameter

Default Value: N/A
Example: scope

String

Specify the parameter for the token endpoint.

Token endpoint parameter value

Default Value: N/A
Example: profile, user

String

Specify the value for the token endpoint parameter.

Auth endpoint config

Use this fieldset to define custom properties for the OAuth2 authentication endpoint.

Authentication parameter

Default Value: N/A
Example: scope

String

Specify the parameter for the token endpoint.

Authentication parameter value

Default Value: N/A
Example: profile, user

String

Specify the value for the OAuth2 authentication parameter.

Snaplex

Default Value: N/A
Example: /snaplogic/shared/cloud

String

Specify the Snaplex path to be used for OAuth2 operations.

Auto-refresh token

Default Value: Deselected

Checkbox

Select this checkbox to enable autorefresh of the access token before it expires.