> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/adapters/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Itential Adapters

## Docs

- [Adapters overview](https://docs.itential.com/adapters/introduction/overview.md): Learn what Itential adapters are, how they work, and how to get started integrating external systems with the Automation Platform.
- [Retired adapters](https://docs.itential.com/adapters/introduction/retired-adapters.md)
- [Get adapters overview](https://docs.itential.com/adapters/get/overview.md): Learn how to get Itential adapters by browsing the pre-built library or generating custom adapters from API specifications.
- [Browse adapter library](https://docs.itential.com/adapters/get/browse-adapter-library.md): Find and download pre-built adapters from Itential's open source library.
- [Build an adapter](https://docs.itential.com/adapters/get/build-an-adapter.md): How to use Adapter Builder to create a custom adapter, including input format requirements, best practices, and troubleshooting guidance.
- [Contribute adapters](https://docs.itential.com/adapters/get/contribute.md): Contribute adapters to Itential's open source library.
- [Install adapters](https://docs.itential.com/adapters/get/install.md): Deploy adapters to Itential Platform through Admin Essentials or command line.
- [Adapter repository file reference](https://docs.itential.com/adapters/install/adapter-repository-files.md): Reference for all Markdown files included in an adapter GitLab repository, with descriptions of each file's purpose.
- [Configuration overview](https://docs.itential.com/adapters/configure/overview.md): Understand adapter configuration and how to connect adapters to external systems.
- [Service instance configuration overview](https://docs.itential.com/adapters/configure/service-instance-configuration/properties/overview.md): An overview of how adapter properties are defined, configured, and overridden in theItential Platform service instance configuration.
- [Base properties](https://docs.itential.com/adapters/configure/service-instance-configuration/properties/base-properties.md): Reference for the top-level adapter properties that control how the adapter communicates with an external system.
- [Authentication properties](https://docs.itential.com/adapters/configure/service-instance-configuration/properties/authentication-properties.md): Reference for the adapter authentication object properties that control how the adapter authenticates with an external system.
- [SSL/TLS properties](https://docs.itential.com/adapters/configure/service-instance-configuration/properties/ssl-tls-properties.md): Reference for the adapter SSL/TLS object properties that control how the adapter handles secure connections to an external system.
- [Request properties](https://docs.itential.com/adapters/configure/service-instance-configuration/properties/request-properties.md): Reference for the adapter request object properties that control how the adapter handles outbound requests to an external system.
- [Healthcheck properties](https://docs.itential.com/adapters/configure/service-instance-configuration/properties/healthcheck-properties.md): Reference for the adapter healthcheck object properties that control how and when the adapter checks the availability of an external system.
- [Proxy properties](https://docs.itential.com/adapters/configure/service-instance-configuration/properties/proxy-properties.md): Reference for the adapter proxy object properties that control how the adapter routes requests through a proxy server.
- [Throttle properties](https://docs.itential.com/adapters/configure/service-instance-configuration/properties/throttle-properties.md): Reference for the adapter throttle object properties that control request queuing when an external system has load or concurrency limitations.
- [Mongo properties](https://docs.itential.com/adapters/configure/service-instance-configuration/properties/mongo-properties.md): Reference for the adapter mongo object properties that configure a database for storing metrics, throttle queue state, and adapter configuration.
- [Deprecated properties](https://docs.itential.com/adapters/configure/service-instance-configuration/properties/deprecated-properties.md): Reference for adapter properties that are no longer recommended and have been replaced by the .system entity.
- [Adapter authentication overview](https://docs.itential.com/adapters/authentication/overview.md): Configure adapters to authenticate with external systems using various authentication methods.
- [AWS authentication](https://docs.itential.com/adapters/authentication/methods/aws.md): How to configure AWS Signature Version 4 authentication in an AWS adapter, including service account keys, STS assume-role, and IAM role methods.
- [Basic authentication](https://docs.itential.com/adapters/authentication/methods/basic.md): How to configure basic authentication in an adapter, including standard setup and common variations.
- [Multi-step authentication](https://docs.itential.com/adapters/authentication/methods/multi-step.md): How to configure multi-step authentication (MSA) in an adapter, including step definitions, schema files, and token caching.
- [OAuth authentication](https://docs.itential.com/adapters/authentication/methods/oauth.md): How to configure OAuth client credentials authentication in an adapter, including service instance configuration and endpoint configuration changes.
- [Static token authentication](https://docs.itential.com/adapters/authentication/methods/static-token.md): How to configure static token authentication in an adapter, including standard setup and common variations.
- [Two-step token authentication](https://docs.itential.com/adapters/authentication/methods/two-step-token.md): How to configure two-step token authentication in an adapter, covering both the service instance configuration and the .system endpoint configuration.
- [Basic authentication to get a token](https://docs.itential.com/adapters/authentication/patterns/basic-auth-to-get-token.md): How to configure a two-step token flow where the initial token request uses basic authentication in the request header instead of a body payload.
- [Handle cookie-based tokens](https://docs.itential.com/adapters/authentication/patterns/token-returned-in-cookie.md): Configure adapters when the system returns authentication tokens in cookies.
- [Authentication to a different host](https://docs.itential.com/adapters/authentication/patterns/different-host.md): How to configure a two-step token flow where the token request is sent to a different host than the one used for subsequent API calls.
- [Dynamic token per domain](https://docs.itential.com/adapters/authentication/patterns/dynamic-token-per-domain.md): How to pass a domain dynamically on each request so the adapter authenticates within the correct domain for that call.
- [Dynamic user per request](https://docs.itential.com/adapters/authentication/patterns/dynamic-user-per-request.md): How to pass user credentials dynamically on each request so the adapter authenticates as the individual user making the call rather than a shared system account.
- [Encoding and encrypting token request values](https://docs.itential.com/adapters/authentication/patterns/encoding-request-values.md): How to use the encode and encrypt schema flags to base64-encode or AES-encrypt individual field values in a token request.
- [Changing data types](https://docs.itential.com/adapters/authentication/patterns/changing-data-types.md): Reference for the request and response data types supported in adapter authentication, and how to set them in action.json.
- [Advanced authentication](https://docs.itential.com/adapters/authentication/advanced.md): An introduction to complex adapter authentication scenarios that use two-step token flows with custom configurations.
- [Endpoint configuration overview](https://docs.itential.com/adapters/configure/endpoint-configuration/overview.md): Define API actions and data schemas for adapter endpoints.
- [action.json overview](https://docs.itential.com/adapters/configure/actions/overview.md): An introduction to the action.json file, which defines the actions an adapter can take with an integrated system.
- [action.json field definitions](https://docs.itential.com/adapters/configure/actions/reference.md): Reference for all fields available in an adapter action.json file.
- [action.json usage examples](https://docs.itential.com/adapters/configure/actions/examples.md): Examples covering entity path variables, schemas, datatypes, timeouts, response objects, mock data, and deprecated fields in action.json.
- [Schemas overview](https://docs.itential.com/adapters/configure/schemas/overview.md): An introduction to adapter schema files and how they define and translate data betweenItential Platform and an external system.
- [Schema field definitions](https://docs.itential.com/adapters/configure/schemas/field-definitions.md): Reference for all fields available in adapter schema files, including general, security, and required field definitions.
- [Schema usage examples](https://docs.itential.com/adapters/configure/schemas/usage-examples.md): Examples covering how schemas are referenced in action.json, including file organization and using separate request and response schemas.
- [Configure SSL/TLS](https://docs.itential.com/adapters/configure/tls.md): How TLS works with Itential adapters, how to validate SSL certificates, and how to troubleshoot SSL failures.
- [Throttling](https://docs.itential.com/adapters/configure/throttling.md): How adapter throttling works, when to use it, and the side effects to consider before enabling it.
- [Configure headers](https://docs.itential.com/adapters/configure/headers.md): How adapters handle request and response headers, and how to add static or dynamic headers to specific calls or all calls.
- [Add dynamic headers](https://docs.itential.com/adapters/configure/add-dynamic-headers.md): How to add headers with values that are not known until call time, using iapMetadata or adapter.js code changes.
- [Add query parameters](https://docs.itential.com/adapters/configure/add-query-parameters.md): How to pass dynamic query parameters to an adapter call using the iapMetadata object, without requiring a code change.
- [Update adapter configuration fromItential Platform](https://docs.itential.com/adapters/configure/update-configuration.md): How to use the iapUpdateAdapterConfiguration task in anItential Platform workflow to update adapter configuration files without making changes directly on the file system.
- [Automation Gateway adapter](https://docs.itential.com/adapters/configure/reference/automation-gateway.md): Reference for configuring the adapter-automation_gateway adapter, including adapter properties, authentication, healthcheck, SSL, throttle, and a sample configuration.
- [NSO adapter](https://docs.itential.com/adapters/configure/reference/nso.md): Reference for configuring the NSO adapter, including adapter properties, sample configuration, itential-tools compatibility, external authentication, NACM rules, NETCONF events, SSL, and LSA setup.
- [SQL adapter](https://docs.itential.com/adapters/configure/reference/sql-adapter.md): Reference for configuring the SQL adapter for direct queries or object-relational mapping (ORM), including adapter properties and sample configurations.
- [Adapter source files](https://docs.itential.com/adapters/customize/adapter-source-files.md): Reference for the core source files in an adapter, including adapter.js, adapterBase.js, and Adapter Utils.
- [Adapter method reference](https://docs.itential.com/adapters/customize/adapter-method-reference.md): Reference for all generic adapter methods and Device Broker methods available in Itential Platform adapters, including method signatures and workflow availability.
- [Work with adapter.js](https://docs.itential.com/adapters/customize/work-with-adapterjs.md): How adapter.js is structured, including generic and broker methods, and how to write specific adapter methods covering parameters, logging, data validation, request construction, and calls to the adapter libraries.
- [Work with the Adapter Utils library](https://docs.itential.com/adapters/customize/work-with-adapter-utils.md): An overview of the Adapter Utils library — what it provides, how its capabilities work, how to use it in adapter.js, and how to update the dependency.
- [Customization examples](https://docs.itential.com/adapters/customize/examples.md): Detailed examples of common adapter customizations
- [Test and lint adapters](https://docs.itential.com/adapters/test/test-and-lint-adapters.md): How to run adapter tests and linting, what each test file covers, how to use debug logging during testing, how to save mock data from integration tests, and best practices for validating a new adapter installation.
- [Linting reference](https://docs.itential.com/adapters/test/linting-reference.md): How adapter linting works, what tool and rule set are used, and the full list of code style rules adapters must follow.
- [Work with mock data](https://docs.itential.com/adapters/test/mock-data.md): How mock data works in adapters, how to define it in action.json, how to use multiple mock files per action, and how to capture mock data from Postman, integration tests, or adapter logs.
- [Troubleshoot adapters overview](https://docs.itential.com/adapters/troubleshooting/overview.md): An introduction to the key components and concepts involved in troubleshooting Itential adapters.
- [Troubleshoot result codes](https://docs.itential.com/adapters/troubleshooting/result-codes.md): Adapter result codes and their meanings.
- [Connectivity](https://docs.itential.com/adapters/troubleshooting/connectivity.md): How to verify network connectivity between theItential Platform server and an external system, and which adapter properties to configure for the connection.
- [Troubleshoot authentication issues](https://docs.itential.com/adapters/troubleshooting/authentication.md): How to identify and resolve authentication issues when troubleshooting an adapter.
- [Adapter dependencies](https://docs.itential.com/adapters/troubleshooting/dependencies.md): How adapter dependencies must be installed, and why installing them above the adapter directory can cause problems.
- [Installation location](https://docs.itential.com/adapters/troubleshooting/installation-location.md): How adapter namespaces determine where an adapter must be installed within theItential Platform node_modules directory.
- [URL paths](https://docs.itential.com/adapters/troubleshooting/url-paths.md): How adapter URL paths are constructed from base_path, version, and entitypath, and how to verify they are correct.
- [Adapter not in Itential Platform](https://docs.itential.com/adapters/troubleshooting/adapter-not-in-iap.md): Steps to take when an adapter is installed but does not appear inItential Platform after a restart.
- [Adapter status is red](https://docs.itential.com/adapters/troubleshooting/adapter-status-is-red.md): Steps to take when an adapter appears inItential Platform but one of its status indicators is red.
- [Adapter is up but no calls are working](https://docs.itential.com/adapters/troubleshooting/no-calls-working.md): Steps to take when an adapter is running but all calls are failing.
- [DEPTH_ZERO_SELF_SIGNED_CERT error](https://docs.itential.com/adapters/troubleshooting/depth-zero-self-signed-cert.md): How to resolve the DEPTH_ZERO_SELF_SIGNED_CERT SSL error when connecting to a server with a self-signed certificate.
- [Not receiving the expected response](https://docs.itential.com/adapters/troubleshooting/wrong-response-data.md): Steps to take when a call succeeds but the adapter returns unexpected or missing data.
- [Not sending the expected request](https://docs.itential.com/adapters/troubleshooting/wrong-request-data.md): Steps to take when the adapter is not sending the correct request data or the data is incorrectly formatted.
- [One or more calls failing](https://docs.itential.com/adapters/troubleshooting/one-or-more-calls-failing.md): Steps to take when an adapter is generally working but specific calls are failing.
- [Tasks not appearing in Platform](https://docs.itential.com/adapters/troubleshooting/tasks-not-in-automation-studio.md): Steps to take when an adapter is loaded inItential Platform but its tasks do not appear in Automation Studio.
- [Troubleshoot linting and testing](https://docs.itential.com/adapters/troubleshoot/specific-scenarios/troubleshoot-linting-and-testing.md): Fix linting errors and test failures in adapters.
- [Here to help](https://docs.itential.com/adapters/support/get-support.md): Contact the Itential Adapter Team for help with adapter issues.