Skip to main content

openLoginPopup()

Home > @backstage/core-app-api > openLoginPopup

Show a popup pointing to a URL that starts an auth flow. Implementing the receiving end of the postMessage mechanism outlined in https://tools.ietf.org/html/draft-sakimura-oauth-wmrm-00

The redirect handler of the flow should use postMessage to communicate back to the app window. The message posted to the app must match the AuthResult type.

The returned promise resolves to the response of the message that was posted from the auth popup.

Signature:

function openLoginPopup(options: OpenLoginPopupOptions): Promise<unknown>;

Parameters

Parameter

Type

Description

options

OpenLoginPopupOptions

Returns:

Promise<unknown>