• Properties exist to allow flexibility in the adapters. Changes to properties can be made through the Itential Application Platform (IAP) user interface (UI). When these changes are made, the adapter will be restarted but IAP will remain up. The ability to refresh adapter properties using refreshProperties does exist, but IAP does not currently make use of that capability.
  • The adapter properties are defined in the propertiesSchema.json file. This is a json schema file that can provide information such as the property data type (String, Integer, Boolean, Enumeration, etc.), a description of the property, and whether there is a default value.
  • You can add additional properties to the propertiesSchema.json file, if needed. The adapter properties that are originally defined in the propertiesSchema.json file are utilized by the adapter-utils libraries. Removing or changing any of the default values for these properties could cause the adapter to not function properly.
  • Adapter properties can be overridden on an individual call through the callProperties defined in the request object. For more on how to do this see the presentation on Adapter Code (adapter.js).
  • Information about adapter properties can also be found in the README.md file for every adapter.

These are properties that should no longer be used. Although they are supported in the code base, it is not a best practice to use them. Knowing about them is helpful since some adapters may still use them instead of the .system entity. These properties were replaced with the .system entity for authentication and healthcheck. The .system entity allows for more expanded capabilities in the token and healthcheck calls.


  • token_user_field (string)
    • Identifies the user credential when requesting a token.
  • token_password_field (string)
    • Identifies the password credential when requesting a token.
  • token_result_field (string)
    • Will contain the token when requesting a token.
  • token_URI_path (string)
    • Used during authentication to retrieve a dynamic token.


  • protocol (string)
    • Defines the protocol (i.e., REST) used to communicate with the other system.
  • URI_Path (string)
    • The call path the healthcheck should make.

Know Your Network. Automate Your Network.

Get Started with Itential Today.