Page Comparison

...

• Base URL: Base URL for an application API which we can be found in the developer documentation for the application. Example: For AHA it would be https://{org domain}/api/v1/.

• Authorization Header Name 1: Name of the header used to pass the token or API key. Many times this is Authorization. Example: For AHA it would be Authorization. If not required, leave blank.

• Authorization Header Value 1: The value for the authorization could be API key (Normal or base64 encoded) and the prefix for the API key could be Bearer or Basic followed by space and then API key. Example: For AHA the API key is a normal key with Bearer as a prefix so the header value will be Bearer APIkey. If not required, leave blank.

• Authorization Header Name 2: Name of the second header. If not required, leave blank.

• Authorization Header Value 2: The value for the second header. If not required, leave blank.

• Pagination strategy: Currently Zilla only supports limit-offset pagination for generic integration so the value must be limit-offset.

• Pagination Overrides: ({"limit": "limit", "offset": "skip"}).: The mapping of the pagination fields from the API response. For example: If the API has pagination support: limit=50&skip=0 then override would be {"limit": "limit", "offset": "skip"}.

• Accounts Endpoint: The endpoint for listing all the users or accounts for an application. Example: For AHA it is users.

• Accounts Response Property: The key value for the users' array IF the response from the API call contains JSON and the users' array is inside a field. Example: For AHA the JSON response of type has users inside users field so the value for this config would be .users. If not required, leave blank.

  Code Block
  language json
  { pagelen: number, size: number users: [ {user1 object}, {user1 object} ] }

• Accounts Property Overrides: The mapping for the response from the API to Zilla fields. Example: For AHA we get the following response for a single user:

  Code Block
  { userId: string, name: string, firstname: string, lastname: string, enabled: boolean, roles: string[], email: string, lastLoggedIn: Date, EID: string . . . so on }

...