Integrations and Scripts Parameter Types
Integration Parameter Types are used to configure instances of the integration. When adding a parameter to an integration in Cortex XSOAR, there are numerous types to choose from. Each type will affect the parameter behavior and interaction with the user. See here for more information how to set the parameter type.
Boolean#
This type of parameter creates a checkbox in the integration configuration. When the checkbox is ticked, the value in
the integration code is True, and False otherwise.
The type number is: 8.
Access: demisto.params().get('proxy')
Short Text#
This type of parameter is used for short input parameters, such as server URLs, ports or queries. It creates a small sized text box in the integration configuration. The type number is: 0.
Access: demisto.params().get('url')
Long Text#
This type of parameter is used for long text inputs, such as certificates. It creates a large sized text box in the integration configuration. The type number is: 12.
Access: demisto.params().get('cert')
Short Encrypted#
This type of parameter is used for encrypted inputs, such as API tokens. This should not be used for username-password credentials however. It creates a small sized text box with an encrypted text, which would also be stored encrypted in the database. The type number is: 4.
Access: demisto.params().get('token')
Long Encrypted#
This type of parameter is used for long encrypted inputs, such as certificates. It creates a text-area with encrypted text. The text would also be stored encrypted in the database. The type number is: 14.
Access: demisto.params().get('cert')
Authentication#
This type of parameter is used for username-password credentials - username as plain text and an encrypted password. It supports retrieving credentials from the Cortex XSOAR credentials store (more info on the credentials store can be found in the Cortex XSOAR support portal). The type number is: 9.
Access:
Username: demisto.params().get('credentials', {}).get('identifier')
Password: demisto.params().get('credentials', {}).get('password')
Single Select#
This type of parameter is used to allow selecting a single input from a list of allowed inputs. The type number is: 15.
Access: demisto.params().get('log')
Multi Select#
This type of parameter is used to allow selecting multiple inputs from a list of allowed inputs. The type number is: 16.
Access: demisto.params().get('sort')
Important Note#
Once a parameter is set in an integration configuration, it is saved to the Cortex XSOAR database, so before changing an existing parameter, you have to consider the existing values (backward compatibility). For example, when adding a parameter with a default value to an existing integration, make sure you add the default value in the code as well as in the yml (As it wont be added to existing instances).