Collect custom user attributes from Google Workspace

For all source systems except Google Workspace, all columns (i.e., attributes) available for collection within a given table are automatically detected and listed on the table's Settings tab when you Choose columns to collect. If you add custom attributes in the source system's resource schemas, they automatically appear in the Settings tab after the next collection. However, for Google Workspace, additional configuration is required.

For more information, see Data tables.

  1. Go to the Google Admin Console at

  2. Add one or more custom attributes to the Google Workspace user schema. See

    For example:

  3. In a text editor, create a .json file with the following structure.

    The object nested inside customSchemas should have the same value as the Category name in step (5). The keys inside that object should correspond to the Custom Field names in step (5).

    For example:

      "schema": {
        "crud_objects": {
          "users": {
            "resources": {
              "customSchemas": {
                "T4e": {
                  "t4eVar1": "_:string*",
                  "t4eVar2": "_:string*",
                  "t4eVar3": "_:string*"
    1. Optional: Repeat step (5) to add additional categories and custom fields. If you do, add additional JSON objects inside the customSchemas object.

  4. Save this file. The filename should be the same as the Google Workspace system's Name in NIM.

    For example, for a system named google, name the file google.json.

  5. Copy the .json file to C:\ProgramData\Tools4ever\NIM\config\rest\systems. You may need to create the \rest\systems sub-tree.

  6. Restart the NIM service. See Troubleshoot NIM.

  7. For this system, Choose columns to collect. The new columns, in the relevant table, are now available to include during collection.

    They are prefixed with customSchemas_.

  8. Collect and load a system for this system.

  9. For the relevant table, View a table's data. The new columns are now included. They are also now available as target attributes in Mappings.