Skip to main content
Version: Next

providers

Home > @backstage/plugin-auth-backend > providers

All built-in auth provider integrations.

Signature:

providers: Readonly<{
atlassian: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("..").OAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: never;
}>;
auth0: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("..").OAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: never;
}>;
awsAlb: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("@backstage/plugin-auth-backend-module-aws-alb-provider").AwsAlbResult> | undefined;
signIn: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("@backstage/plugin-auth-backend-module-aws-alb-provider").AwsAlbResult>;
};
} | undefined) => AuthProviderFactory;
resolvers: never;
}>;
bitbucket: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("..").OAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: Readonly<{
userIdMatchingUserEntityAnnotation: () => import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
usernameMatchingUserEntityAnnotation: () => import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
}>;
}>;
bitbucketServer: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("./bitbucketServer").BitbucketServerOAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("./bitbucketServer").BitbucketServerOAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: Readonly<{
emailMatchingUserEntityProfileEmail: () => import("@backstage/plugin-auth-node").SignInResolver<import("./bitbucketServer").BitbucketServerOAuthResult>;
}>;
}>;
cfAccess: Readonly<{
create: (options: {
authHandler?: import("./types").AuthHandler<import("./cloudflare-access").CloudflareAccessResult> | undefined;
signIn: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("./cloudflare-access").CloudflareAccessResult>;
};
cache?: import("@backstage/backend-plugin-api").CacheService | undefined;
}) => AuthProviderFactory;
resolvers: Readonly<typeof import("@backstage/plugin-auth-backend-module-cloudflare-access-provider").cloudflareAccessSignInResolvers>;
}>;
gcpIap: Readonly<{
create: (options: {
authHandler?: import("./types").AuthHandler<import("@backstage/plugin-auth-backend-module-gcp-iap-provider").GcpIapResult> | undefined;
signIn: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("@backstage/plugin-auth-backend-module-gcp-iap-provider").GcpIapResult>;
};
}) => AuthProviderFactory;
resolvers: never;
}>;
github: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("./github").GithubOAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("./github").GithubOAuthResult>;
} | undefined;
stateEncoder?: import("./types").StateEncoder | undefined;
} | undefined) => AuthProviderFactory;
resolvers: Readonly<{
usernameMatchingUserEntityName: () => import("@backstage/plugin-auth-node").SignInResolver<import("./github").GithubOAuthResult>;
}>;
}>;
gitlab: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("..").OAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: never;
}>;
google: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("..").OAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: Readonly<{
emailMatchingUserEntityProfileEmail: () => import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
emailLocalPartMatchingUserEntityName: () => import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
emailMatchingUserEntityAnnotation: () => import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
}>;
}>;
microsoft: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("..").OAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: Readonly<{
emailMatchingUserEntityProfileEmail: () => import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
emailLocalPartMatchingUserEntityName: () => import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
userIdMatchingUserEntityAnnotation: () => import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
emailMatchingUserEntityAnnotation: () => import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
}>;
}>;
oauth2: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("..").OAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: never;
}>;
oauth2Proxy: Readonly<{
create: (options: {
authHandler?: import("./types").AuthHandler<import("@backstage/plugin-auth-backend-module-oauth2-proxy-provider").OAuth2ProxyResult> | undefined;
signIn: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("@backstage/plugin-auth-backend-module-oauth2-proxy-provider").OAuth2ProxyResult>;
};
}) => AuthProviderFactory;
resolvers: never;
}>;
oidc: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("@backstage/plugin-auth-backend-module-oidc-provider").OidcAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("@backstage/plugin-auth-backend-module-oidc-provider").OidcAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: Readonly<{
emailLocalPartMatchingUserEntityName: () => import("@backstage/plugin-auth-node").SignInResolver<unknown>;
emailMatchingUserEntityProfileEmail: () => import("@backstage/plugin-auth-node").SignInResolver<unknown>;
}>;
}>;
okta: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("..").OAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: Readonly<{
emailLocalPartMatchingUserEntityName: () => import("@backstage/plugin-auth-node").SignInResolver<unknown>;
emailMatchingUserEntityProfileEmail: () => import("@backstage/plugin-auth-node").SignInResolver<unknown>;
emailMatchingUserEntityAnnotation(): import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
}>;
}>;
onelogin: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("..").OAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("..").OAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: never;
}>;
saml: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("./saml").SamlAuthResult> | undefined;
signIn?: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("./saml").SamlAuthResult>;
} | undefined;
} | undefined) => AuthProviderFactory;
resolvers: Readonly<{
nameIdMatchingUserEntityName(): import("@backstage/plugin-auth-node").SignInResolver<import("./saml").SamlAuthResult>;
}>;
}>;
easyAuth: Readonly<{
create: (options?: {
authHandler?: import("./types").AuthHandler<import("@backstage/plugin-auth-backend-module-azure-easyauth-provider").AzureEasyAuthResult> | undefined;
signIn: {
resolver: import("@backstage/plugin-auth-node").SignInResolver<import("@backstage/plugin-auth-backend-module-azure-easyauth-provider").AzureEasyAuthResult>;
};
} | undefined) => AuthProviderFactory;
resolvers: never;
}>;
}>