From efa549c4abcc8703184718acfa1c8019504de473 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= <freben@gmail.com>
Date: Wed, 2 Mar 2022 13:47:03 +0100
Subject: [PATCH] form refs properly in resolver docs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
---
 docs/auth/identity-resolver.md | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

diff --git a/docs/auth/identity-resolver.md b/docs/auth/identity-resolver.md
index a33351e938..3b355470d1 100644
--- a/docs/auth/identity-resolver.md
+++ b/docs/auth/identity-resolver.md
@@ -27,6 +27,8 @@ sign-in resolvers and set them for any of the Authentication providers inside
 `@backstage/plugin-auth-backend` plugin.
 
 ```ts
+import { DEFAULT_NAMESPACE, stringifyEntityRef } from '@backstage/catalog-model';
+
 export default async function createPlugin({
   ...
 }: PluginEnvironment): Promise<Router> {
@@ -38,22 +40,31 @@ export default async function createPlugin({
           resolver: async ({ profile: { email } }, ctx) => {
             // Call a custom validator function that checks that the email is
             // valid and on our own company's domain, and throws an Error if it
-            // isn't
+            // isn't.
+            // TODO: Implement this function
             validateEmail(email);
 
             // List of entity references that denote the identity and
             // membership of the user
-            const ent = [];
+            const ent: string[] = [];
 
             // Let's use the username in the email ID as the user's default
             // unique identifier inside Backstage.
             const [id] = email.split('@');
-            ent.push(`User:default/${id}`)
+            ent.push(stringifyEntityRef({
+              kind: 'User',
+              namespace: DEFAULT_NAMESPACE,
+              name: id,
+            }));
 
             // Let's call the internal LDAP provider to get a list of groups
             // that the user belongs to, and add those to the list as well
             const ldapGroups = await getLdapGroups(email);
-            ldapGroups.forEach(group => ent.push(`Group:default/${group}`))
+            ldapGroups.forEach(group => ent.push(stringifyEntityRef({
+              kind: 'Group',
+              namespace: DEFAULT_NAMESPACE,
+              name: group,
+            })));
 
             // Issue the token containing the entity claims
             const token = await ctx.tokenIssuer.issueToken({