diff --git a/docs/auth/identity-resolver--old.md b/docs/auth/identity-resolver--old.md index c1a207484a..267f3e9d3c 100644 --- a/docs/auth/identity-resolver--old.md +++ b/docs/auth/identity-resolver--old.md @@ -9,7 +9,7 @@ This documentation is written for the old backend which has been replaced by [the new backend system](../backend-system/index.md), being the default since Backstage [version 1.24](../releases/v1.24.0.md). If have migrated to the new backend system, you may want to read [its own article](./identity-resolver.md) -instead. +instead. Also, check out [the migration docs](../backend-system/building-backends/08-migrating.md)! ::: By default, every Backstage auth provider is configured only for the use-case of diff --git a/docs/auth/identity-resolver.md b/docs/auth/identity-resolver.md index b09b47a572..39fc13fcb2 100644 --- a/docs/auth/identity-resolver.md +++ b/docs/auth/identity-resolver.md @@ -194,6 +194,13 @@ backend.add(import('@backstage/plugin-auth-backend-module-github-provider')); backend.add(customAuth); ``` +Check out [the naming patterns +article](../backend-system/architecture/07-naming-patterns.md) for what rules +apply regarding how to form valid IDs. In this example we also put the module +declaration directly in `packages/backend/src/index.ts` but that's just for +simplicity. You can place it anywhere you like, including in other packages, and +import from there if you prefer. + The `createOAuthProviderFactory` / `createProxyAuthProviderFactory` functions have additional options for profile and state transforms - not covered here, but good to know about if you need them. @@ -234,6 +241,13 @@ async signInResolver(info, ctx) { } ``` +If you throw an error in the sign in resolver function, the sign in attempt is +immediately rejected, and the error details are presented in the user interface. + +The `ctx` context [has several useful +functions](https://backstage.io/docs/reference/plugin-auth-node.authresolvercontext/) +for issuing tokens in various ways. + ### Custom Ownership Resolution If you want to have more control over the membership resolution and token generation