Add Google Workspace Custom Schema Fields to System

Google Workspace guide

Follow this focused guide to configure and validate Google Workspace in NIM.

Google Workspace custom schemas are specific to each tenant. To collect their values in NIM, add the custom-schema structure to the NIM REST system configuration, then include the resulting fields in the Google Workspace Users table.

NIM imports a custom field using this name format:

customSchemas_<schemaName>_<fieldName>

For example, the ID field in a schema named Tools4ever becomes customSchemas_Tools4ever_ID.

Before you begin

• Create the custom schema and fields in Google Workspace first. See Add Custom Schema Fields to Google Workspace.
• Record the exact schema and field names. The JSON property names must match Google Workspace exactly.

Add the custom schema configuration

1. On the NIM server, create this directory if it does not already exist:

   C:\ProgramData\Tools4ever\NIM\config\rest\systems

2. Create a JSON file in that directory. Use the following example for a Google Workspace schema named Tools4ever with the fields ID, Type, and DeleteDate:

   {
     "schema": {
       "crud_objects": {
         "users": {
           "resources": {
             "customSchemas": {
               "Tools4ever": {
                 "ID": "_:string*",
                 "Type": "_:string*",
                 "DeleteDate": "_:string*"
               }
             }
           }
         }
       }
     }
   }

3. Name the file to match the Google Workspace system name in NIM. For example, if the NIM system is named GoogleWorkspace, save the file as GoogleWorkspace.json.

4. If your Google schema or field names differ from the example, update the corresponding JSON property names before saving the file.

Add the fields to the NIM Users table

After creating the configuration file, update the Google Workspace Users table settings in NIM and add the relevant customSchemas_<schemaName>_<fieldName> fields.

Validate the collectionCollect the Google Workspace system after saving the file. If custom fields do not appear, verify the file name matches the NIM system name and that every schema and field name matches Google Workspace exactly.