help.nightfall.ai / nightfall_settings / directory_sync / google_workspace.md
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending
.mdto page URLs; this page is available as Markdown.
Google Workspace Directory Service
This document explains the process of adding your Google Workspace tenant to Nightfall to enable Directory Sync. Once you add Google Workspace to Nightfall, you can sync users and user groups data from Google Workspace to Nightfall. To get an overview of the Directory Sync feature in Nightfall, you can read this article and then proceed with this document.
To install Google Directory:
- Click the Settings button in Nightfall.
- Click the Directory Sync tab.
- Click Add directory.
- Select Google Workspace as the identity provider.
- Copy the Client ID and OAuth Scope ID. Store these values in a secure place. You require them in the further steps.
- Login to your Google Workspace with an admin account.
- Click the menu icon.
- Select Admin.
- In the Admin console left pane, expand Security and then expand Access and data control.
- Click API controls.
- Click MANAGE DOMAIN WIDE DELEGATION under Domain wide delegation.
- Click Add New.
- Paste the Client ID copied from the Nightfall app, in the Client ID field.
- Paste the Scopes ID copied from the Nightfall app, under OAuth Scope field. Use comma to add multiple scope IDs.
- Click AUTHORIZE.
- Return to the Nightfall app and click Continue.
- Click Connect.
Once the setup is completed, Nightfall displays the list of active and inactive users in your Google Workspace. Nightfall syncs with your Identity and Access Provider every four hours. Also, you can manually sync once every hour. To sync data manually, click the ellipsis menu and select Refresh.
<figure><!--kb:media-unavailable--><figcaption></figcaption></figure>Currently, once registered you cannot unregister an Identity and Access Provider from Nightfall. If you wish to unregister your Identity and Access Provider, please contact Nightfall support.
Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the ask query parameter, and the optional goal query parameter:
GET https://help.nightfall.ai/nightfall_settings/directory_sync/google_workspace.md?ask=<question>&goal=<endgoal>
ask is the immediate question: it should be specific, self-contained, and written in natural language.
goal is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.