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

# Configure

## Docs

- [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.