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