Configuration pages type
A new configuration page to be added to IBM® QRadar®. An app can define any user interaction that is required.
In QRadar,
configuration_pages
are represented as icons in the Admin
tab.
The following table describes the configuration_pages
block fields in the
manifest.json
file.
Field | Type | Description | Required |
---|---|---|---|
text | String | Concise text to display that describes the configuration page. This field can optionally point at a resource bundle key if the application is globalized. | Yes |
description | String | Detailed text to display that describes the area. This field can optionally point at a resource bundle key if the application is globalized. | Yes |
icon | String | Path to the icon for your app on the Admin tab, relative to the application root. Icons must be 32x32 pixels. | Yes |
url | String | A URL to load, relative to the application root. Only URLs that exist within the QRadar application can be referenced. | Yes |
required_capabilities | Array of String | A set of capabilities that a user must affiliate with their user role to access this configuration page. | No |
The following code is a sample configuration_pages
block from the
manifest.json file:
...
"configuration_pages": [
{
"text":"Open mycompany.com",
"description":"Loading mycompany.com in a new window",
"icon":null,
"url":"my_config_page",
"named_service":"nodejsservice"
"required_capabilities":["ADMIN"]
}
],
...