What is the difference between a Service Account and a Normal User in Appian?
What is the difference between a Service Account and a Normal User in Appian?
Answer
Normal users and service accounts are both user accounts in Appian, but they’re for different jobs.
- A normal user is a person who logs into Appian to use applications, complete tasks and carry out business operations.
- A service account is a non-human identity for system-to-system integrations, API authentication and Appian Portals. It can’t log into Appian interactively.
Main differences
Feature | Normal user | Service account |
|---|---|---|
Purpose | Human interaction | System-to-system communication |
Appian login | Yes | No |
Authentication | Appian login, LDAP or SSO | API key or OAuth 2.0 client credentials |
SAIL interfaces | Can use interfaces | Can’t log in to use interfaces |
User tasks | Can complete assigned tasks | Not meant for human tasks |
Web APIs | Can call APIs with supported user authentication | Built for API access |
Permissions | Based on roles, groups and object security | Based on groups and object security |
Inactivity | Subject to the configured inactivity policies | Not deactivated automatically for inactivity |
Example: Invoice Approval application
Take an Appian application that manages invoices and integrates with an external ERP system.
Scenario 1: Normal User
An employee logs into Appian to submit an invoice:
- The employee logs into an Appian site.
- They open the Create Invoice form.
- They enter the invoice details and submit the form.
- An approver gets a task and approves or rejects the invoice.
This scenario needs normal users because people are filling in forms and completing workflow tasks.
Scenario 2: Service Account
An external ERP system needs to send invoice data to Appian automatically, with no person involved.
Implementation:
- Create a Web API in Appian, such as
POST /invoices. - Create a service account named
svc_invoice_integration. - Generate an API key or set up an OAuth 2.0 client for the service account.
- Add the service account to an application group that has the required Web API permissions.
- Configure the ERP system to call the Appian Web API with those credentials.
- The Web API validates the invoice data and creates a record or starts the right process.
Example API request:
Result: the ERP system sends invoice data to Appian securely through a service account, and nobody has to log in.
How to create a service account in Appian
- Go to Admin Console > Web API Authentication.
- Choose API key or OAuth 2.0 client credentials authentication.
- Create a new service account or pick an existing one.
- Add the service account to the right application security group.
- Grant the permissions it needs on the Web API and any other objects.
- Configure the external application to authenticate with the generated credentials.
Important: a service account belongs to the Service Accounts system group. Creating a regular user whose name starts with svc_ doesn’t make it a service account.
Security best practices
- Least privilege: give the account only the permissions the integration needs.
- Separate accounts: use a different service account for each unrelated integration where you can.
- Credential security: store API keys and client secrets securely, and never hardcode them in application source code.
- Environment setup: create service accounts separately in DEV, TEST and PROD, keeping usernames and group memberships consistent where it makes sense.
- Authorization: make sure the account can reach only the APIs, records and processes it needs.
Interview point
You don’t automatically need a service account for every scheduled process or background job in Appian.
For example, a process model that runs on a timer doesn’t need one. Service accounts are mainly for authenticating non-human access into Appian, such as incoming Web API requests and portal operations.
In the same way, when Appian calls an external REST API, you usually set up authentication in the Connected System. That outbound integration doesn’t automatically need an Appian service account.
Check yourself
Question 1 of 3, on what the answer above covers.
- 1.An external system needs to automatically send invoice data to an Appian Web API without human intervention. Which account should be used?
- 2.An external application calls an Appian Web API with a valid API key, but the service account does not have permission to access the API. What should you do?
- 3.Your Appian application needs to call an external Salesforce REST API using OAuth 2.0. Do you need to create an Appian service account?