Eloqua OAuth2 Account

Eloqua OAuth2 Account

In this article

Overview

Use this account type to connect Eloqua Snaps with datasources that use Eloqua OAuth2 accounts.

Prerequisites

  • None.

Account Settings

Parameter Name

Data Type

Description

Default Value

Example 

Parameter Name

Data Type

Description

Default Value

Example 

Label

String

Required. The name for the account. Preferably, update the account name if your project includes more than one account of the same type.

N/A

Eloqua Oauth2 Account

Endpoint

String

Required. URI for fetching base REST API.

Eloqua supports multiple data centers, and the https://login.eloqua.com/id endpoint lets you interface with Eloqua regardless of the location of the Eloqua install. For information on endpoint URIs, see Determining Base URLs.

N/A

https://login.eloqua.com/id

Client ID

String

Required. The identification for the client that you obtain from the API console.

For more information, see Validating a Call Signature.

N/A

4kty30218ty930f8hr0ma8709

Client secret

String

A secret key known only to SnapLogic and the authorization server. It protects your resources by granting tokens to only authorized users.

N/A

N/A

Access token

String

Read-onlyAn object that describes the security context of SnapLogic. The token includes the identity and privileges of the user account. This property is automatically populated after the account is authorized.

The access token is retrieved when setting up the account for the endpoint. The OAuth2 flow is executed at the endpoint and the resulting access token is stored in this property.

Access tokens have limited lifetimes; you must get a new access token after it expires.

If the access token is refreshable, an optional refresh token can be stored. You get a new access token after the expiry of the existing access token if a refresh token was not defined, or if both the access and the refresh token expire.

N/A

N/A

Refresh token

String

Read-only. Credentials that are used to acquire new access tokens. This property is automatically populated after the account is authorized. 

Refresh tokens can also expire but have a much longer lifetime.

The refresh token is retrieved when setting up the account for the endpoint. The OAuth2 flow is executed at the endpoint and the resulting refresh token is stored in this property. If the refresh token is stored, the access token can be refreshed automatically before it expires.

N/A

N/A

Access token expiration

String

Read-only. Number of seconds that the access token must be valid. This property is automatically populated after the account is authorized.

N/A

N/A

Header authenticated

String

Enable if the endpoint uses bearer header authentication.

Not Selected

N/A

OAuth2 Endpoint

String

RequiredURL of the endpoint's authorization.

N/A

https://login.eloqua.com
/auth/oauth2/authorize

OAuth2 Token

String

RequiredURL of the endpoint's access token.

N/A

https://login.eloqua.com
/auth/oauth2/token

Token endpoint config

String

Provides custom properties for the OAuth2 token endpoint.

N/A

N/A

Token endpoint parameter

String

An optional OAuth2 token endpoint parameter.

N/A

grant_type

Token endpoint parameter value

String

An optional OAuth2 token endpoint parameter value.

N/A

password

Auth endpoint config

String

Provides custom properties for the OAuth2 auth endpoint.

N/A

N/A

Authentication parameter

String

An optional OAuth2 authentication parameter.

N/A

response_type

Authentication parameter value

String

An optional OAuth2 authentication parameter value.

N/A

code

Auto-refresh token

String

  • When selected, the refresh token refreshes the access token automatically.

  • When not selected, the access token expires after its lifetime.

When the access token expires, the user is forced to sign in again.

Not Selected

N/A

Limitations

  • None

Troubleshooting

  • None.