Authentication

Most systems require users to be authenticated in order to accomplish tasks within that system. System to system communication often requires similar or more stringent authentication. Thus, adapters often need to authenticate to the system they are trying to communicate with. There are some standard authentications techniques:

• Basic Authentication user and password based
• Forms of Static Token like API-key or Personal Access Tokens
• Forms of dynamic Two Step Token like OAuth

Configuring adapter authentication includes:

• Changing property values within the authentication sub-section of the IAP Service Instance Configuration for the adapter in IAP Admin Essentials. The most common property values to change include:
  • auth_method
  • credentials (username, password, token)
  • auth_field
  • auth_field_format

Typically this is all you will need to change for Basic Authentication and Static Token. If authenticating with a dynamic Two Step Token, you may also need to change the Endpoint Configuration in the .system entity (/adapter-home-dir/entities/.system):

• getToken action – Defines the call to use to get the token. The most common fields to change here are:
  • entitypath
  • datatypes - requestDatatype, responseDatatype
  • overriding headers
  • sso
• Schema files used by getToken – Defines how the data will be sent on the token request as well as defining where the adapter can find the token in the response. You may have to put additional fields into the requestSchema file and set the external_name for the token in the responseSchema file.

There are example types of authentication and how to configure various authentication techniques described in the Authentication Articles.