@backstage/plugin-auth-backend

Home > @backstage/plugin-auth-backend

A Backstage backend plugin that handles authentication

Classes

Class	Description
CatalogIdentityClient	A catalog client tailored for reading out identity data from the catalog.
OAuthAdapter

Functions

Function	Description
createAuthProviderIntegration(config)	Creates a standardized representation of an integration with a third-party auth provider. The returned object facilitates the creation of provider instances, and supplies built-in sign-in resolvers for the specific provider.
createOriginFilter(config)
createRouter(options)
ensuresXRequestedWith(req)
getDefaultOwnershipEntityRefs(entity)	Uses the default ownership resolution logic to return an array of entity refs that the provided entity claims ownership through. A reference to the entity itself will also be included in the returned array.
postMessageResponse(res, appOrigin, response)
verifyNonce(req, providerId)

Interfaces

Interface	Description
OAuthHandlers
RouterOptions

Variables

Variable	Description
authPlugin	Auth plugin
defaultAuthProviderFactories	All auth provider factories that are installed by default.
encodeState
OAuthEnvironmentHandler
prepareBackstageIdentityResponse
providers	All built-in auth provider integrations.
readState

Type Aliases

Type Alias	Description
AuthHandler	The AuthHandler function is called every time the user authenticates using the provider. The handler should return a profile that represents the session for the user in the frontend. Throwing an error in the function will cause the authentication to fail, making it possible to use this function as a way to limit access to a certain group of users.
AuthHandlerResult	The return type of an authentication handler. Must contain valid profile information.
AuthProviderConfig
AuthProviderFactory
AuthProviderRouteHandlers
AuthResolverCatalogUserQuery
AuthResolverContext
AuthResponse
AwsAlbResult	The result of the initial auth challenge. This is the input to the auth callbacks.
BitbucketOAuthResult
BitbucketPassportProfile
BitbucketServerOAuthResult
CloudflareAccessClaims	CloudflareAccessClaims Can be used in externally provided auth handler or sign in resolver to enrich user profile for sign-in user entity
CloudflareAccessGroup	CloudflareAccessGroup
CloudflareAccessIdentityProfile	CloudflareAccessIdentityProfile Can be used in externally provided auth handler or sign in resolver to enrich user profile for sign-in user entity
CloudflareAccessResult
CookieConfigurer
EasyAuthResult
GcpIapResult	The result of the initial auth challenge. This is the input to the auth callbacks.
GcpIapTokenInfo	The data extracted from an IAP token.
GithubOAuthResult
OAuth2ProxyResult
OAuthAdapterOptions
OAuthLogoutRequest
OAuthProviderInfo
OAuthProviderOptions	Common options for passport.js-based OAuth providers
OAuthRefreshRequest
OAuthResponse
OAuthResult
OAuthStartRequest
OAuthStartResponse
OAuthState
OidcAuthResult
ProfileInfo
ProviderFactories
SamlAuthResult
SignInInfo
SignInResolver
StateEncoder
TokenParams
WebMessageResponse