Modules
Display conditions

Rate this page:

Jira admin page

The jira:adminPage module adds an item in the Apps section of the left navigation of Jira admin settings. When the item is clicked, content is rendered on a new Jira page. You can use the UI kit or custom UI to create content for the Jira page. When using the UI kit in the app, use the AdminPage component as a top-level component.

The page URL is constructed in the form of: /jira/settings/apps/{appId}/{envId}

This module can be used in Jira Core, Jira Software, and Jira Service Management.

Properties

PropertyTypeRequiredDescription
key

string

Yes

A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstringThe admin page module requires a function for use with the UI kit or a resource when building with custom UI.A reference to the function module that defines the admin page. This function must return the AdminPage component.
resourcestringA reference to the static resources entry that your admin page wants to display. See resources for more details.
resolver{ function: string }Contains a function property, which references the function module that defines the configuration of resource. Can only be set if the module is using the resource property.
titlestringYesThe title of the admin page, which is displayed at the top of the page. The title also appears as an item in the `Apps` section of the left navigation of Jira admin settings.
iconstringThe URL of the icon that's displayed next to the title. A generic app icon is displayed if no icon is provided.
layoutnative|basic (default: native)The layout of the admin page, which defines the elements that should be displayed on the page (for example, page title).
displayConditionsobjectThe object that defines whether or not a module is displayed in the UI of the app. See display conditions.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.

UI kit

PropertyTypeDescription
typestringThe type of the module.

Rate this page: