For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
  • Introduction
    • Overview
    • Retired adapters
      • Overview
        • Overview
        • Base properties
        • Authentication properties
        • SSL/TLS properties
        • Request properties
        • Healthcheck properties
        • Proxy properties
        • Throttle properties
        • Mongo properties
        • Deprecated properties
      • SSL/TLS
      • Throttling
      • Headers
      • Add dynamic headers
      • Add query parameters
      • Update adapter configuration
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • Authentication
  • Healthcheck
ConfigureService instance configuration

Deprecated properties

Was this page helpful?
Previous

Adapter authentication overview

Next
Built with

The properties listed on this page should not be used in new or updated adapters. They remain supported in the codebase, but they are not best practice. Some older adapters may still use them.

These properties were replaced by the .system entity, which provides expanded capabilities for token requests and healthchecks. If your adapter uses these properties, migrate to the .system entity.

Authentication

PropertyTypeDescription
token_user_fieldstringThe field name that should contain the login username when requesting a token.
token_password_fieldstringThe field name that should contain the password when requesting a token.
token_result_fieldstringThe field name in the token response that contains the returned token.
token_URI_pathstringThe URI path used to retrieve an authentication token for a dynamic token request.

Healthcheck

PropertyTypeDescription
protocolstringThe protocol (for example, REST) used to communicate with the external system.
URI_PathstringThe path used to check whether the external system is up and operational.