Configuring OpenAPI Accounts
- Anand Vedam
- Kalpana Malladi
- Ankur Parekh
- Mohammed Iqbal
Overview
You can create OpenAPI accounts to connect to data sources that you want to use in your Pipelines.
Snap-Account Compatibility
Snaps in the OpenAPI Snap Pack work with different accounts and protocols per the following table.
| Snap | No account | OpenAPI Basic Auth Account | OpenAPI OAuth2 Account | OpenAPI Dynamic OAuth2 Account |
|---|---|---|---|---|
| OpenAPI | ✔ | ✔ | ✔ | ✔ |
Configuring OpenAPI Accounts
You can configure your OpenAPI accounts in SnapLogic using either the Designer or Manager.
Using SnapLogic Designer
Drag an OpenAPI Snap to the Canvas and click the Snap to open its settings. Click the Account tab. You can now either use an existing account or create a new one.
Selecting an existing account
SnapLogic organizes and displays all accounts to which you have access, sorting them by account type and location. To select an existing account:
- Click the
icon to view the accounts to which you have access and select the account that you want to use. - Click
.
Creating an account
- Click Add Account in the Account Reference dialog.
- Select the Location in which you want to create the account, select the account type, and click Continue. The Add Account dialog associated with the account type appears.
Enter the required account details. For detailed guidance on how to provide information associated with each account type, use the following links:
Enter additional information on this account in the Notes field of the Info tab. This will help you–and other users–understand the purpose of the account, especially if there are multiple accounts of the same type.
- Click Validate to verify the account, if the account type supports validation.
- Click Apply to complete configuring the OpenAPI account.
Using SnapLogic Manager
Use Manager to create accounts without associating them immediately with Pipelines.
Accounts in SnapLogic are associated with projects. You can use accounts created in other projects only if you have at least Read access to them.
- In the left pane, browse to the project in which you want to create the account and click Create > Account > OpenAPI, followed by the appropriate account type.
The Create Account dialog associated with the selected account type appears. - Repeat the steps numbered 3 through 5 in the previous section.
Avoid updating account credentials while Pipelines using that account are executing. This may lead to unexpected results, including locking your account.
Snap Pack History
See Also
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.