AuthConnector

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

An AuthConnector is responsible for realizing auth session actions by for example communicating with a backend or interacting with the user.

Signature:

export type AuthConnector<AuthSession> = {
    createSession(options: AuthConnectorCreateSessionOptions): Promise<AuthSession>;
    refreshSession(options?: AuthConnectorRefreshSessionOptions): Promise<AuthSession>;
    removeSession(): Promise<void>;
};

References: AuthConnectorCreateSessionOptions, AuthConnectorRefreshSessionOptions