Skip to main content

HttpAuthService

Home > @backstage/backend-plugin-api > HttpAuthService

Provides handling of credentials in an ongoing request.

See the service documentation for more details.

Signature:

export interface HttpAuthService 

Methods

Method

Description

credentials(req, options)

Extracts the caller's credentials from a request.

issueUserCookie(res, options)

Issues a limited access token as a cookie on the given response object. This is only possible for requests that were originally made with user credentials (such as a Backstage token).

This must be called before sending any payload data.