Skip to content

Commit

Permalink
docs: update auth providers usage
Browse files Browse the repository at this point in the history
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
  • Loading branch information
Rugvip committed Jun 20, 2022
1 parent 9d40407 commit 3faed18
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 13 deletions.
7 changes: 2 additions & 5 deletions contrib/docs/tutorials/aws-alb-aad-oidc-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,7 @@ When using ALB auth you can configure it as described [here](https://backstage.i
- replace the content of `packages/backend/plugin/auth.ts` with the below and tweak it according to your needs.

```ts
import {
createRouter,
createAwsAlbProvider,
} from '@backstage/plugin-auth-backend';
import { createRouter, providers } from '@backstage/plugin-auth-backend';
import {
DEFAULT_NAMESPACE,
stringifyEntityRef,
Expand All @@ -145,7 +142,7 @@ export default async function createPlugin({
database,
discovery,
providerFactories: {
awsalb: createAwsAlbProvider({
awsalb: providers.awsAlb.create({
authHandler: async ({ fullProfile }) => {
let email: string | undefined = undefined;
if (fullProfile.emails && fullProfile.emails.length > 0) {
Expand Down
12 changes: 5 additions & 7 deletions docs/auth/bitbucket/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ In order to use the Bitbucket provider for sign-in, you must configure it with a
`signIn.resolver`. See the
[Sign-In Resolver documentation](../identity-resolver.md) for more details on
how this is done. Note that for the Bitbucket provider, you'll want to use
`bitbucket` as the provider ID, and `createBitbucketProvider` for the provider
`bitbucket` as the provider ID, and `providers.bitbucket.create` for the provider
factory.

The `@backstage/plugin-auth-backend` plugin also comes with two built-in
Expand All @@ -74,16 +74,14 @@ same way, but uses the Bitbucket user ID instead, and matches on the
The following is an example of how to use one of the built-in resolvers:

```ts
import {
createBitbucketProvider,
bitbucketUsernameSignInResolver,
} from '@backstage/plugin-auth-backend';
import { providers } from '@backstage/plugin-auth-backend';
// ...
providerFactories: {
bitbucket: createBitbucketProvider({
bitbucket: providers.bitbucket.create({
signIn: {
resolver: bitbucketUsernameSignInResolver,
resolver:
providers.bitbucket.resolvers.usernameMatchingUserEntityAnnotation(),
},
}),
},
Expand Down
2 changes: 1 addition & 1 deletion docs/auth/identity-resolver.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ export default async function createPlugin(
return await createRouter({
...
providerFactories: {
google: createGoogleProvider({
google: providers.google.create({
authHandler: async ({
fullProfile // Type: passport.Profile,
idToken // Type: (Optional) string,
Expand Down

0 comments on commit 3faed18

Please sign in to comment.