Skip to main content

Connect Google Workspace to NIM

Google Workspace guide

Set up the Google Cloud service account, authorize access in Google Admin, then add the credentials to NIM and test the connection.

Platform referencesDirect link to Platform references

For Google Workspace requirements outside NIM, review Google's domain-wide delegation guidance. Review the authorized client and scopes regularly, and limit delegated scopes to the Google Workspace data and operations your NIM implementation uses.

Google's OAuth consent setup describes the current Google Auth Platform screens. Its credential setup explains where to find the service account's numeric client ID.

What you needDirect link to What you need

To connect NIM to Google Workspace, create a Google Cloud project and service account, download its P12 key, authorize that service account through Google Workspace domain-wide delegation, and add the P12 certificate to NIM. You also need the Google Workspace customer ID and an administrator account with the required roles for the Directory (Tenant) ID.

Use a Google Workspace super administrator to authorize domain-wide delegation. The Google Cloud account also needs permission to enable APIs, create the service account, and create its key. If an organization policy blocks key creation, ask your Google Cloud administrator to review the approved authentication setup; see Google's service-account key guidance. This NIM procedure uses a P12 certificate.

Success looks like this: after saving the Google system in NIM, Test Connection returns a success message. You can then collect the system and confirm the tables needed by your process are available.

Follow the three stages below, switching between NIM Studio, Google Cloud, and Google Admin as directed. Select a screenshot to enlarge it; perform the illustrated actions in the relevant application.

Create the NIM system and Google Cloud service accountDirect link to Create the NIM system and Google Cloud service account

  1. In NIM Studio, go to Systems > Overview.

  2. Click Add.

  3. Select Google for System Type.

  4. Enter a System Name.

  5. Click Save.

  6. The new system is added to the Configured Systems pane.

  7. In a new tab, open the Google Cloud console.

  8. Create a new project named NIM and switch to it.

  9. Open Cloud Shell and confirm its active project is the NIM project you selected.

  10. Run these commands in Cloud Shell to enable the Google APIs used by this setup:

    gcloud services enable admin.googleapis.com
    gcloud services enable groupssettings.googleapis.com
    gcloud services enable licensing.googleapis.com
    gcloud services enable drive.googleapis.com
    gcloud services enable gmail.googleapis.com
    gcloud services enable classroom.googleapis.com

  11. Open Google Auth Platform > Branding. Depending on the console navigation, APIs & Services > OAuth consent screen opens this area.

  12. If you see Google Auth Platform not configured yet, select Get Started. If it is already configured, review the existing Branding, Audience, and contact information, then continue with service-account creation below.

  13. For a new configuration, complete the setup:

    • App Information: enter NIM for App name, choose a User support email, and select Next.
    • Audience: select Internal, then Next.
    • Contact Information: enter an email address for project notifications, then select Next.
    • Finish: review the Google API Services User Data Policy. If you agree, select its agreement checkbox, then Continue and Create.

  14. Open APIs & Services > Credentials.

  15. Select Create Credentials > Service Account.

  16. For Service account name, enter NIM. Accept the generated Service account ID, select Create and Continue, and complete creation with Done.

  17. Open the service account by selecting its email address. Record its Email and numeric Unique ID from Details. You can also find the numeric Client ID under Show advanced settings > Domain-wide delegation. Keep the email address and numeric client ID distinct for the fields below.

  18. Open Keys > Add Key > Create New Key. Select P12, then Create. Store the downloaded .p12 file securely and record its private-key password (notasecret), then select Close.

Step 1 of 3

Next stepsDirect link to Next steps

Return to the Google Workspace integration to choose a task such as license assignment or user offboarding.

Last updated on