SSL OAuth2 Account
In this article
Overview
You can use this account type to connect API Suite Snaps with data sources that use SSL OAuth2 accounts.
Prerequisites
Valid Client ID and Client secret.
Limitations and Known Issues
None.
Account Settings
Asterisk ( * ): Indicates a mandatory field.
Suggestion icon ( ): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the fieldset.
Remove icon ( ): Indicates that you can remove fields from the fieldset.
Field Name | Field Type | Description | |
---|---|---|---|
Label*
Default Value: N/A | String | Specify a unique and meaningful name for your account.
| |
Client ID* Default Value: N/A | String | Specify the client ID associated with your account. You can create the client ID as advised by your application provider. | |
Client secret Default Value: N/A | String | Specify the client secret associated with your account. You can create the client secret as advised by your application provider. | |
Access token Default Value: N/A | String | Auto-generated after authorization. SnapLogic® uses this token to make API requests on behalf of the user associated with the client ID. The retrieval of the access token is done when setting up the account for the endpoint. The resulting access token obtained from the OAuth2.0 flow is stored in this field. | |
Refresh token Default Value: N/A | String | Auto-generated after authorization. The refresh token associated with your account. If the refresh token is stored, then the access token can be refreshed automatically before the token expires. | |
Access token expiration Default Value: Current Time + 3600 seconds | String | Auto-generated after authorization. The access token expiration value, in seconds. | |
Header authenticated Default Value: Deselected | Checkbox | Select this checkbox to indicate that the endpoint uses bearer header authentication. You must select the Header Authenticated checkbox in the account for the successful execution of the pipeline. You might be able to authorize the account successfully with or without enabling that checkbox. However, the pipeline fails if the checkbox is deselected in the account. | |
OAuth2 authorization endpoint* Default Value: N/A | String | Specify the authorization endpoint that authorizes the application.
| |
OAuth2 token endpoint* Default Value: N/A | String | Specify the URL of the endpoint that retrieves the token for an authenticated account.
| |
Grant type Default Value: Authorization Code | Dropdown List | Select the method of authorization:
| |
KeyStore Default Value: N/A | String | Specify the location of the key store file. It can be in SLDB or at any other unauthenticated endpoint.
| |
TrustStore Default Value: N/A | String | Specify the location of the trust store file. It can be in SLDB or at any other unauthenticated endpoint.
| |
Key/Trust store password Default Value: N/A | String | Specify the password for the key/trust store. It is used for both Key and Trust stores, if both are defined.
| |
Key alias Default Value: N/A | String | Specify the alias of the key that you want to use with this account.
| |
Token endpoint config | Use this field set to provide custom properties for the OAuth2 token endpoint. | ||
Token endpoint parameter | String | Specify an optional token endpoint parameter.
| |
Token endpoint parameter value | String | Specify the value associated with the optional endpoint parameter defined above.
| |
Auth endpoint config | Use this field set to provide custom properties for the OAuth2 auth endpoint. | ||
| Auth endpoint parameter
| String | Define an optional authorization endpoint parameter.
|
| Auth endpoint value
| String | Specify the value associated with the optional authorization endpoint parameter defined above.
|
Auto-refresh token Default Value: Deselected | Checkbox | Select this checkbox to refresh the token automatically using the refresh token. When you deselect this checkbox, the token expires and is not refreshed automatically. | |
Authorize
| Button | Click this button to authorize the REST OAuth2 account using the credentials provided in the Client ID, Client secret, OAuth2 authorization endpoint, and OAuth2 token endpoint fields. | |
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 you generate a token. |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
One or more required fields are blank. | You click Authorize in the account dialog window, but one or more of the following fields is blank:
| Insert valid details into the following fields and click Authorize.
|
| Got response 401 - Unauthorized from the endpoint. | Refer to the error document in the error view for more information. |
Snap Pack History
Related Links
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.