Jira Service Management portal profile panel

The jiraServiceManagement:portalProfilePanel module adds a panel to the Profile page in Jira Service Management portal.

This module can be used in Jira Service Management.

For UI Kit 1, see the PortalProfilePanel component documentation for more details.

Unlicensed user access: This module supports interaction with customer accounts and unlicensed accounts. It does not support anonymous access. For information, see Access to Forge apps for unlicensed users.

Example of a portal profile panel

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_-]+$

resourcestringIf using Custom UI or modern versions of UI KitThe key of a static resources entry that your module will display. See resources for more details.
render'native'If using modern versions of UI KitIndicates the module uses UI Kit.
functionstringDeprecated Required if using UI Kit 1The key of a function module that returns a UI Kit 1 component.
resolver{ function: string } or
{ endpoint: string }

Set the function property if you are using a hosted function module for your resolver.

Set the endpoint property if you are using Forge remote to integrate with a remote back end.

titlestring or i18n objectYes

The title of the Forge app.

The i18n object allows for translation. See i18n object.

unlicensedAccessList<string>A list of unlicensed user types that can access this function. Valid values for this module are: unlicensed and customer. This module does not support anonymous access. For more information, see Access to Forge apps for unlicensed Jira Service Management users.

i18n object

KeyTypeRequiredDescription
i18nstringYesA key referencing a translated string in the translation files. For more details, see Translations.

Extension context

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.

PropertyTypeDescription
typestringThe type of the module.
pagestringThe page where the module is rendered.

UI Kit 1

PropertyTypeDescription
typestringThe type of the module.

Rate this page: