R12.3-2026Apr21
API Authenticator

As third-party integrations become increasingly important in our system, the API Authenticator Manager is provided at the domain level to centrally manage authentication for external system communications. The API authenticator stores only authentication information, such as a username and password. The URL and front server used to communicate with third-party systems are not included in the API authenticator. It supports three authentication methods: API Key, Basic Authentication, and OAuth 2.0. It is noteworthy that API authenticator supports the widely adopted OAuth 2.0 authorization framework. OAuth 2.0 defines how clients request authorization, how users authorize access between clients and applications, and how authorization information is exchanged to obtain credentials for third-party applications to access user resources. API Authenticators can be used with Outgoing Webhooks, API Adapters, and TechSpec. 


The table below explains the meaning of each column in the API Authenticator pane.

No.ColumnDescription
1NameThe API Authenticator’s name
2MethodThis method configured for the API Authenticator
3Last Modified TimeLast modified time of the API Authenticator
4Modified ByThe last user who modified this API Authenticator
5Status

This field shows the most recent authentication result for the API Authenticator. The status is updated when the API Authenticator is tested and saved, or when it is used by other features for authentication.

The meanings of the status are listed below:

  • Succeeded: Authentication completed successfully.
  • Failed: If authentication fails, the reason for the failure is displayed in the Status column, such as server_error.
  • Need to login: When the API Authenticator is configured to use the Authorization Code or Authorization Code with PKCE grant type and the user has not logged in to the OAuth authorization server, the status is shown as “Need to Login”. User can click the Login button to open the login UI, then sign in, then the status will change to “Connected”.
  • Connected: When the API Authenticator is configured to use the Authorization Code or Authorization Code with PKCE grant type and the user has logged in to the OAuth authorization server successfully, the status is shown as “Connected”.
6Last UpdatedThis indicates the time when the status was last updated.
Information Note: The Domain Management privilege is required to access the API Authenticator Manager.