Flow Access

Integration-level management tasks are only available to users with the correct permissions. See the Users documentation for more details.

Create a Service Account

You must authenticate the requests to flow endpoints. Authentication credentials are created as service accounts in Utilihive Heartbeat.

To create a service account, select Service Accounts from the left-hand navigation menu, and select Create in the top-right corner.

The form to create a service account includes fields for the account name and credential type.

Input a Service account name, select the Credential type, and then Create.

Credential Types

The credential type can be one of the following options:

Type Description

API key

A single, auto-generated string. Set as the value of the HTTP header named apiKey. For example: header name — apiKey, header value — HzjQL6Z9VyszduJOPbE8.

Basic authentication

A username/password pair, where the username is the account name and the password is auto-generated. Used in an HTTP authorization header as a Base64-encoded string. For example: header name — Authorization, header value — Basic dXNlcm5hbWU6cGFzc3dvcmQK.

mTLS

Certificate-based authentication. Server authenticates the client using the certificates provided by the client during the TLS handshake. See mTLS for more information.

Poller user

No credentials, because authentication is handled by the server. Used for flows that don’t have a public API endpoint. For example: file pollers.

For basic authentication and API keys, you will only have access to the auto-generated string once. Make sure you copy it somewhere, or select the save button ( ) to download the string as a text file.

If you misplace a service account’s credentials, you can generate new ones. Select the edit button ( ) from the service account list, and then select Reset Credential.

After you select the Create button, the service account is created immediately, even if you don’t complete the next step.

Grant Access to Flows

During the service account creation process, you will be asked which flows this account can access. If you don’t choose any flows at this time, you can still add flows later by selecting the edit button ( ).

Alternatively, you can navigate to an individual flow and select the Flow Access tab to review the accounts for that flow and add new accounts. The following image demonstrates what this page looks like:

The Flow Access tab displays a list of service accounts with an Add Flow Access button underneath.

After a service account has been added to a flow, you can make HTTP requests with the account’s credentials or add the credentials to the flow’s Documentation page to test endpoints in the browser.