Skip to main content

AuthProviderRouteHandlers.start()

Home > @backstage/plugin-auth-node > AuthProviderRouteHandlers > start

Handles the start route of the API. This initiates a sign in request with an auth provider.

Request - scopes for the auth request (Optional) Response - redirect to the auth provider for the user to sign in or consent. - sets a nonce cookie and also pass the nonce as 'state' query parameter in the redirect request

Signature:

start(req: Request, res: Response): Promise<void>;

Parameters

ParameterTypeDescription
reqRequest
resResponse

Returns:

Promise<void>