Script API Credential - AnalyticsGate/AGR-OnPrem-Setups GitHub Wiki

type

Description

This parameter describes the type of authentication.

Example

type: SESSION

key

Description

The name of the authentication key. This may vary depending on the type of authentication.

Example

key: X-Qlik-Session-ser

value

Description

The value of the authentication key. This may vary depending on the type of authentication.

Example

value: 936DA01F-9ABD-4D9D-80C7-02AF85C822A8

useBase64Password

Description

If an "outputPassword” with encrypted Base64-text is to be used, this parameter must be set to "true”.

Default: false

Example

useBase64Password: true

encryptType

Description

Sets the encryption algorithm. The possible choice is AES256 or RSA256.

  • Long texts can only be encrypted with AES256.
  • With RSA you can encrypt only up to 64 characters.

Default: RSA256

Example

encryptType: AES256

cert

Description

The path to a certificate that is needed for the connection. Again, this depends on the connection type.

Example

cert: %appdata%\AnalyticsGate\AGR\certificates\serconnector.pem

privateKey

Description

The path to the private key that is needed for the connection. Again, this depends on the connection type.

Example

privateKey: %appdata%\AnalyticsGate\AGR\certificates\serconnector_private.key