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.

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

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

See the AdminPage component documentation for an example. When adding this to your app, use it as a top-level component.

Example of an admin page

Subpages

By default, the jira:adminPage module registers a top-level page. However, there is an option to register multiple pages using a pages or sections field.

Use pages to add individual pages to the sidebar and sections to group pages.

The sidebar will only change the admin page URL, you will need to handle routes inside your custom UI app using view.createHistory().

This feature works only with custom UI.

Properties

Property	Type	Required	Description
`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_-]+$`
`function`	`string`	The 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.
`resource`	`string`		A 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.
`title`	`string`	Yes	The 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.
`icon`	`string`		The absolute URL of the icon that's displayed next to the title. Relative URLs aren't supported. A generic app icon is displayed if no icon is provided.
`layout`	`native\|basic` (default: `native`)		The layout of the admin page that defines whether a page is rendered with default controls (native) or lays out the entire viewport (basic).
`pages`	`Page[]`	You can only specify `pages` or `sections` but not both.	The list of subpages to render on the sidebar.
`sections`	`Section[]`	You can only specify `pages` or `sections` but not both.	The list of sections to render on the sidebar.
`displayConditions`	`object`		The object that defines whether or not a module is displayed in the UI of the app. See display conditions.

Page

Property	Type	Required	Description
`title`	`string`	Yes	The title of the subpage, which is displayed on the sidebar.
`icon`	`string`		The URL of the icon that's displayed next to the subpage title. A generic app icon is displayed if no icon is provided.
`route`	`string`	Yes	The unique identifier of the subpage. This identifier is appended to the admin page URL.

Section

Property	Type	Required	Description
`header`	`string`		The section header.
`pages`	`Page[]`	Yes	The list of subpages to render on the sidebar.

Extension context

Custom UI

Property	Type	Description
`type`	`string`	The type of the module.

UI kit

Property	Type	Description
`type`	`string`	The type of the module.