BackstageIdentityApi

Home > @backstage/core-plugin-api > BackstageIdentityApi

This API provides access to the user's identity within Backstage.

Signature:

export type BackstageIdentityApi = {
    getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentityResponse | undefined>;
};

References: AuthRequestOptions, BackstageIdentityResponse

Remarks

An auth provider that implements this interface can be used to sign-in to backstage. It is not intended to be used directly from a plugin, but instead serves as a connection between this authentication method and the app's IdentityApi