What Are the Different Types of Web API Authentication in Appian?
What Are the Different Types of Web API Authentication in Appian?
Answer
Appian supports six authentication methods for securing Web APIs.External applications use Web APIs to pull data from Appian, send information to it or start business processes. Every request has to be authenticated as an authorized Appian user or service account.
1. API key authentication
API key authentication uses a unique API key tied to an Appian service account. The external application sends the key in the HTTP request header.
Example: an external CRM application sends customer information to an Appian Web API using an API key.
Things to know:
- You generate API keys in the Appian Admin Console.
- Each API key belongs to a service account.
- The service account needs permission to access the Web API.
- API keys don’t expire on their own.
Use case: simple system-to-system integrations, where an external application calls Appian without using anyone’s personal login.
2. Basic authentication
Basic authentication checks a request against an Appian username and password, sent in the HTTP Authorization header.
Example: an external application calls an Appian Web API with the credentials of an Appian-authenticated integration user.
Things to know:
- It works for Appian-authenticated and LDAP-authenticated users.
- It doesn’t work for service accounts or for members of the SAML system group.
- It isn’t available when default MFA enforcement is turned on.
- For new system integrations, API keys or OAuth 2.0 are usually a better fit.
Use case: existing integrations that already rely on supported username and password authentication.
3. OAuth 2.0: client credentials grant
With OAuth 2.0 client credentials, the external application authenticates with an access token instead of an Appian username and password. The OAuth client is tied to an Appian service account.
Example: a banking system automatically sends loan application data to Appian through a Web API. It gets an OAuth access token and includes it when it calls Appian.
Things to know:
- It uses token-based authentication.
- It’s built for application-to-application communication.
- Nobody has to log in interactively.
- Requests run with the permissions of the linked service account.
Use case: secure enterprise integrations between Appian and other applications.
4. OAuth 2.0: authorization code grant
The OAuth 2.0 authorization code grant lets an external application call an Appian Web API on behalf of a specific signed-in Appian user. Client credentials run as a service account, but this grant keeps the identity of the individual user.
Example: a loan officer signs in through an external web application to look at loan information stored in Appian. The application gets an authorized access token and calls the Appian Web API as that user.
Things to know:
- It uses the identity of the signed-in Appian user.
- It supports user-specific authorization.
- Appian checks object security and record-level security for that user.
- It’s useful when different users should have different levels of access.
Use case: external applications that need to reach Appian data with each user’s own permissions.
5. Mutual TLS (mTLS) authentication
Mutual TLS adds another layer of security by having the client and the server verify each other with digital certificates.
Example: a financial institution requires certificate-based verification for every external system that connects to its Appian Web APIs.
Things to know:
- It uses trusted X.509 v3 client certificates.
- An administrator has to configure it.
- Once it’s turned on, it applies to every Web API in the Appian environment.
- The request still has to include supported API credentials, such as an API key or an OAuth token.
Use case: enterprise integrations that need extra certificate-based security.
6. Session-based authentication
Session-based authentication relies on an Appian browser session the user is already signed in to. When that user’s browser makes a Web API request, Appian recognizes the session from its cookies.
Example: a user signs in to Appian and uses a feature that calls an Appian Web API from the browser.
Things to know:
- It uses an existing Appian login session.
- It supports API calls made from the browser.
- It works with Appian authentication or SAML SSO.
- It can’t be used for backend-to-backend integration from an external system.
Use case: browser features that run inside an existing signed-in Appian session.
Quick comparison
Authentication type | Best use case |
|---|---|
API key | Simple external system integration |
Basic authentication | Supported username and password integrations |
OAuth 2.0 client credentials | Application-to-application integration |
OAuth 2.0 authorization code | External application acting on behalf of a user |
Mutual TLS | Extra certificate-based security |
Session-based | Browser calls using an Appian session |
Check yourself
Question 1 of 3, on what the answer above covers.
- 1.An external banking application needs to automatically submit loan applications to Appian every hour. The integration must use OAuth 2.0 access tokens and run without requiring an individual user to sign in. Which authentication method should the developer configure?
- 2.A company has developed an external Loan Management web application that integrates with Appian. Loan officers sign in and retrieve loan information through Appian Web APIs. Appian must identify each loan officer and enforce record-level security based on their permissions. Which authentication method best satisfies this requirement?
- 3.An organization enables Mutual TLS (mTLS) authentication for its Appian environment. An external application sends a Web API request using a valid client certificate trusted by Appian. However, the request does not include an API key, OAuth token, or Basic Authentication credentials. Will the certificate alone be sufficient?