@backstage/plugin-auth-node
Home > @backstage/plugin-auth-node
Common functionality and types for the Backstage auth plugin.
Classes
Class |
Description |
---|---|
An identity client to interact with auth-backend and authenticate Backstage tokens This is not a stable API yet | |
An identity client to interact with auth-backend and authenticate Backstage tokens This is not a stable API yet | |
Functions
Function |
Description |
---|---|
Parses the given authorization header and returns the bearer token, or undefined if no bearer token is given. | |
Parses a Backstage-issued token and decorates the BackstageIdentityResponse with identity information sourced from the token. | |
Interfaces
Interface |
Description |
---|---|
Resolver interface for resolving the ownership entity references for entity | |
Any Auth provider needs to implement this interface which handles the routes in the auth backend. Any auth API requests from the frontend reaches these methods. The routes in the auth backend API are tied to these methods like below
| |
Response object containing the BackstageUserIdentity and the token from the authentication provider. | |
A representation of a successful Backstage sign-in. Compared to the BackstageIdentityResponse this type omits the decoded identity information embedded in the token. | |
An identity client api to authenticate Backstage tokens This is not a stable API yet | |
Namespaces
Namespace |
Description |
---|---|
A collection of common sign-in resolvers that work with any auth provider. |
Variables
Variable |
Description |
---|---|
Core properties of various token types. |
Type Aliases
Type Alias |
Description |
---|---|
A query for a single user in the catalog. If If If Regardless of the query method, the query must match exactly one entity in the catalog, or an error will be thrown. | |
The context that is used for auth processing. | |
User identity information within Backstage. | |
The callback used to resolve the cookie configuration for auth providers that use cookies. | |
Options to request the identity from a Backstage backend request | |
An identity client options object which allows extra configurations This is not a stable API yet | |
A type for the serialized value in the | |
Used to display login information to user, i.e. sidebar popup. It is also temporarily used as the profile of the signed-in user's Backstage identity, but we want to replace that with data from identity and/org catalog service | |
Describes the function that transforms the result of a successful authentication into a ProfileInfo object. This function may optionally throw an error in order to reject authentication. | |
Type of sign in information context. Includes the profile information and authentication result which contains auth related information. | |
Describes the function which handles the result of a successful authentication. Must return a valid BackstageSignInResult. | |
Parameters used to issue new Backstage Tokens | |
Payload sent as a post message after the auth request is complete. If successful then has a valid payload with Auth information else contains an error. |