Another SCIM/lookup example, adds Circle API v2

Author: typeoneerror

examples/nm/data/groups.json

@@ -1,4 +1,9 @@
 [
+  {
+    "displayName": "AW Alpha",
+    "id": "2ebb373f-3023-4e43-a81d-a62cb3292f06",
+    "memberCount": 25
+  },
   {
     "displayName": "AW Example Editors",
     "id": "901fc64c-1167-4a43-8a3c-b906f08858a9",
@@ -12,7 +17,7 @@
   {
     "displayName": "Architecting Workspaces",
     "id": "0a5337ff-8343-4da6-a285-fe5c48b9660f",
-    "memberCount": 0
+    "memberCount": 1
   },
   {
     "displayName": "Content Editors",
@@ -32,26 +37,41 @@
   {
     "displayName": "Formula Fundamentals 2.0",
     "id": "70158620-4985-4b86-b08e-95657b6d2edf",
-    "memberCount": 117
+    "memberCount": 123
+  },
+  {
+    "displayName": "Managers",
+    "id": "8f01b40a-b3ec-41e4-8b27-f01ab29f77ae",
+    "memberCount": 1
   },
   {
     "displayName": "Notion Mastery",
     "id": "7d3e5712-a873-43a8-a4b5-2ab138a9e2ea",
-    "memberCount": 522
+    "memberCount": 485
   },
   {
     "displayName": "Notion Mastery Alumni",
     "id": "922f01d5-b5e4-4f13-9be7-411242a2c68b",
-    "memberCount": 1160
+    "memberCount": 1155
   },
   {
     "displayName": "Notion Mastery Membership",
     "id": "9e7b05bc-e9e6-4b7a-8246-f8b1af875ea2",
-    "memberCount": 289
+    "memberCount": 256
   },
   {
     "displayName": "Team",
     "id": "6b4b5525-5248-4bee-9d4a-05d5114b58b9",
     "memberCount": 4
+  },
+  {
+    "displayName": "Vendor Editors",
+    "id": "6f01ed99-c859-4022-b852-0295b1ca217d",
+    "memberCount": 0
+  },
+  {
+    "displayName": "Vendor Management",
+    "id": "ae45a99e-bbf9-4b99-bcab-1a644c854e23",
+    "memberCount": 2
   }
 ]

examples/nm/member-add-aw.js

@@ -0,0 +1,106 @@
+/**
+ * Add a new or existing Member to the "AW Alpha" group in Notion
+ * and the "Architecting Workspaces" access group in Circle
+ */
+
+const { notion } = require('../shared');
+const { findCircleMember, addToAccessGroup } = require('../shared/circle');
+const { yargs, RED_COLOR } = require('../shared/scim');
+const { findMember, addMemberToGroup } = require('./shared');
+
+const argv = yargs
+  .option('groupId', {
+    alias: 'g',
+    describe: 'The ID of the group to add the User to',
+    demand: true,
+    default: '2ebb373f-3023-4e43-a81d-a62cb3292f06',
+  })
+  .option('email', {
+    alias: 'e',
+    describe: "User's email address",
+    demand: true,
+  }).argv;
+
+const dataSourceId = '527dfb28-a457-4b45-99d3-8ee18497a725';
+
+async function findStudentByEmail(email) {
+  const {
+    results: [student],
+  } = await notion.dataSources.query({
+    data_source_id: dataSourceId,
+    filter: {
+      property: 'Email',
+      email: {
+        equals: email,
+      },
+    },
+  });
+
+  return student;
+}
+
+async function tagStudent(student) {
+  const params = {
+    page_id: student.id,
+    properties: {
+      Tags: {
+        multi_select: [{ name: 'Architecting Workspaces' }],
+      },
+    },
+  };
+
+  await notion.pages.update(params);
+}
+
+(async () => {
+  console.info(`Finding student <${argv.email}>...`);
+
+  const student = await findStudentByEmail(argv.email);
+
+  if (!student) {
+    return console.log(RED_COLOR, `No student record by email <${argv.email}> found`);
+  }
+
+  console.info('Tagging student...');
+
+  await tagStudent(student);
+
+  let {
+    Name: {
+      title: [{ plain_text: name }],
+    },
+    Email: { email: email },
+    NMID: {
+      rich_text: [{ plain_text: NMID }],
+    },
+    'Circle Email': { email: circleEmail },
+  } = student.properties;
+
+  circleEmail = circleEmail || email;
+
+  console.info(`Finding member with ID (${NMID})...`);
+
+  const member = await findMember(NMID);
+
+  if (!member) {
+    return console.log(RED_COLOR, `Could not find ${name} <${email}> (${NMID})`);
+  }
+
+  console.info(`Adding member to group (${argv.groupId})...`);
+
+  await addMemberToGroup(argv.groupId, NMID);
+
+  console.info(`Looking up Circle member <${circleEmail}>...`);
+
+  let circleMember = await findCircleMember(circleEmail);
+
+  if (!circleMember) {
+    return console.log(RED_COLOR, `Could not find Circle member <${circleEmail}>`);
+  }
+
+  console.info(`Adding to Circle access group...`);
+
+  await addToAccessGroup(circleMember.email);
+
+  console.log('Done!');
+})();

examples/nm/member-add.js

@@ -33,6 +33,7 @@ const groupKeyToId = {
   nm: '7d3e5712-a873-43a8-a4b5-2ab138a9e2ea', // Notion Mastery
   membership: '9e7b05bc-e9e6-4b7a-8246-f8b1af875ea2', // Notion Mastery Membership
   ff: '70158620-4985-4b86-b08e-95657b6d2edf', // Formula Fundamentals 2.0
+  aw: '2ebb373f-3023-4e43-a81d-a62cb3292f06', // Architecting Workspaces
 };
 
 (async () => {

examples/shared/circle.js

@@ -3,6 +3,7 @@ const { default: axios } = require('axios');
 const yargs = require('yargs/yargs')(process.argv.slice(2));
 
 const CIRCLE_BASE_URI = 'https://app.circle.so/api/v1/';
+const CIRCLE_BASE_URI_V2 = 'https://app.circle.so/api/admin/v2/';
 const CIRCLE_COMMUNITY_ID = 493;
 const CIRCLE_SPACE_GROUP_IDS = [
   18581, // Welcome
@@ -13,6 +14,7 @@ const CIRCLE_SPACE_GROUP_IDS = [
 dotenv.config();
 
 const token = yargs.argv.circleToken || process.env.CIRCLE_API_TOKEN;
+const tokenV2 = yargs.argv.circleTokenV2 || process.env.CIRCLE_API_TOKEN_V2;
 const communityId =
   yargs.argv.communityId || process.env.CIRCLE_COMMUNITY_ID || CIRCLE_COMMUNITY_ID;
 
@@ -23,6 +25,14 @@ const circle = axios.create({
   },
 });
 
+const circleV2 = axios.create({
+  baseURL: CIRCLE_BASE_URI_V2,
+  headers: {
+    Authorization: `Token ${tokenV2}`,
+    'Content-Type': 'application/json',
+  },
+});
+
 async function findCircleMember(email) {
   // GET https://app.circle.so/api/v1/community_members/search
 
@@ -83,11 +93,24 @@ async function findAndRemoveCircleMember(email) {
   }
 }
 
+async function addToAccessGroup(email, access_group_id = '70021') {
+  const { data } = await circleV2.post(`access_groups/${access_group_id}/community_members`, {
+    email,
+  });
+
+  if (data.success === false) {
+    return false;
+  }
+
+  return data;
+}
+
 module.exports = {
   CIRCLE_BASE_URI,
   CIRCLE_COMMUNITY_ID,
   circle,
   addCircleMember,
+  addToAccessGroup,
   findAndRemoveCircleMember,
   findCircleMember,
   removeCircleMember,