An integration flow runs on behalf of a person or an
organization to synchronize data between multiple applications. Each step
of an integration flow is accessing a particular application, for example
through an API, to retrieve, store or update some data. Usually
an API requires a client to authenticate before the data can be accessed.
Each step of an integration flow needs a
put, a credential is an object holding the required information to
authenticate with an API. Let’s have a look at a couple of credential
As you can see in the examples above, a
credential is specific to the
API it is used to authenticate with. This means a credential for a
Salesforce component will not work with a credential for a Database
component or any other API.
When creating a flow an credential must be chosen. You can either chose an existing one or create a new one. The following screenshot demonstrates how the credential is created for the Petstore API component.
As you can see in the screenshot above, a user is asked to provide values for two input fields:
secretAPI key to try out this API.
Once a credential is saved, it will be linked with the current step of the flow. It can be also reused in other steps of the same flow or other flows using same component.
Note Before saving a credential, the elastic.io platform performs a verification by sending a “dry” request to the particular API. This allows us to avoid saving invalid credentials caused by typos, invalidated API keys, etc.
All the created credentials can be managed in one place. If you wish to
have an on overview of all your credentials just go to
where you will find the
Security Credentials area, as shown in the
Now go into
Security Credentials to find an overview of credentials,
shown in the following screenshot:
As you can see in the screenshot above the credentials are structured by
components. You will probably recall that we mentioned above that a
credential is specific to the API it is used to authenticate with. The
green number on a component icon tells you how many credentials exist for that
component. Now if you click on a component, you will see the list of
credentials for a given component, as shown in the screenshot below.
In the screenshot above you can see all available credentials for the
Petstore component belonging to a user. A new credential can be added by
Add New Account button. An existing credential can also be
edited or deleted. This is accomplished by clicking the
button on an existing credential. The following screenshot shows how a credential
Note Please note that it is not possible to delete a credential used by an active integration flow as the flow would become broken. If you try to delete such a credential, a corresponding error message will be displays. Please delete these flow first or reconfigure them to use another credentials.