Jira Service Management portal header

The jiraServiceManagement:portalHeader module adds a panel at the top of customer portal pages. This module can be used in Jira Service Management.

You can use the UI kit or custom UI to create content for the Jira Service Management page.

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

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

Example of a portal header

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 portal header 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 queue page. This function must return the PortalHeader component.
`resource`	`string`		A reference to the static `resources` entry that your customer portal header 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.
`viewportSize`	`'xsmall'`,`'small'`, `'medium'`, `'large'` or `'xlarge'`		The display size of `resource`. Remove this property to enable automatic resizing of the module.
`pages`	`help_center`,`portal`, `create_request`, `view_request`, `approvals`,`profile` or `my_requests`		Restrict the module to only be visible in specified customer portal pages.
`unlicensedAccess`	List<string>		A list of unlicensed user types that can access this function. Valid values for this module are: `unlicensed`, `customer`, and `anonymous`. For more information, see Access to Forge apps for unlicensed Jira Service Management users.

Extension context

Custom UI

Property	Type	Description
`type`	`string`	The type of the module.
`page`	`string`	The location of the page where the module is rendered. Values include `help_center`,`portal`, `create_request`, `view_request`, `approvals`,`profile` and `my_requests`.
portal: `id`	`number`	The id of the service desk, depending on the page where it is rendered.
request: `typeId`	`number`	The id of the request type, depending on the page where it is rendered.
request: `key`	`string`	The key of the request, depending on the page where it is rendered.

UI kit

Property	Type	Description
`type`	`string`	The type of the module.
`page`	`string`	The location of the page where the module is rendered. Values include `help_center`,`portal`, `create_request`, `view_request`, `approvals`,`profile` and `my_requests`.
portal: `id`	`number`	The id of the service desk, depending on the page where it is rendered.
request: `typeId`	`number`	The id of the request type, depending on the page where it is rendered.
request: `key`	`string`	The key of the request, depending on the page where it is rendered.