For the complete documentation index, see llms.txt. This page is also available as Markdown.

Service accounts

A service account is a special type of Appfarm account to represent a non-human user. A service account enables such a user to be authenticated and authorized to access data, run services, and call flow API Endpoints. Service accounts are used to allow external applications to run a service, for schedules to trigger a service, and for unauthenticated access. The use of a service account ensures automated and anonymous interactions with your solution remain secure and traceable.

A service account can be assigned roles in the same way that a user can. If a service account will run a Flow, for example through a Flow API endpoint, that access must be granted under Permissions > Flows. If it will access a service, that access must be granted under Permissions > Services. A service account that calls an API with an API key also needs login access to the environment it calls.

When authentication is required, for example when an external service is calling an API, you can generate API keys for a service account. The API key must then be included as a token when sending the request. If you want to learn how to use API keys when third parties integrate towards Appfarm - please read more here.

When an app is configured for unauthenticated access a service account is used to represent the anonymous users. This is required in order to define which permissions those users have. The permissions are granted to one or more roles assigned to the service account.

Properties

Property
Description

Name

Used as a reference across Appfarm Create.

Roles

One or more roles to assigned to the service account.

Description

A longer description of the service account. For your own reference.

API keys

Click a service account in the list to view and create API keys for that account.

A key is generated and displayed only once. Appfarm has no way to recover the key for you if you lose it. If a secret key is lost or compromised, you should delete it and generate a new one.

All key settings (Name, Expire date, Inactivity expiration and Scope) are fixed once the key is generated. To change them, generate a new key and delete the old one.

The Scope section of the key decides which APIs the key can call.

Property
Description

Name

A unique name for the key.

Expire date

A date on which the key will expire. If a date is not set the key will be valid indefinitely.

Inactivity expiration

The number of seconds the key can go unused before it expires. The countdown starts when the key is created and resets each time the key is used. Minimum value: 3600 seconds (1 hour). If empty, the key never expires from inactivity.

Services

The services the key can access.

Note that the service account for this key must also have a role with the required permissions for the services and the data that

the services are processing.

Flows

The flows the key can access via API Endpoints and MCP servers. A request with the key to a flow that isn't selected here gets status 403. The key list shows these as Approved Flows. Note that the service account for this key must also have a role with the required permissions for the flows and the data that the flows are processing.

GraphQL

Enable access to the solution's GraphQL endpoint.

Time series

Enable use of the time series endpoints with this key.

Data extract

Enable use of the data extract endpoints with this key.

Last updated

Was this helpful?