Google G Suite
Note
This feature requires Enterprise Edition.
Genian NAC can use G Suite directories as a source of user and organization information. Through G Suite synchronization, user accounts can be created locally for management or policy use.
The basic operation method uses the Policy Server to access the G Suite workspace and synchronize information using the OAuth Client ID generated in G Suite.
The following describes how to synchronize user and organization information based on G Suite.
Connecting and Testing
To perform a connection test, the following default values must be entered:
| Item | Setting Value | Description |
|---|---|---|
| Google G Suite | Google Auth Code | The Google authentication code must be inserted in the Data Synchronization details. |
| DOMAIN | Enter if synchronizing only for a specific domain within the workspace. | |
| VIEW TYPE | Select the VIEW from which to read data. admin_view : Administrator privileges domain_public : Public privileges | |
| Data Source ID | Set when using multiple synchronization configurations. | |
| Policy Server |
|
|
Note
If the connection test is not successful, please first confirm normal communication between the Policy Server and the Synchronization Server.
G Suite Prerequisites
OAuth Consent Screen Settings
Access https://console.cloud.google.com/ and go to the API & Services menu.
In the left panel, go to the OAuth consent screen menu.
Select 'External' for User Type, and when a pop-up window appears, select 'Test' and click the
Createbutton.Enter required items such as App Name and click the
Savebutton.In Scope for Information Access, click the
Add or Remove Scopesbutton.In the "Add custom scopes" section below, enter the following 2 lines and click the
Updatebutton.https://www.googleapis.com/auth/admin.directory.orgunit.readonly https://www.googleapis.com/auth/admin.directory.user.readonly
Click the
Save and Continuebutton.Click the
ADD USERSbutton to add accounts allowed to access the OAuth app. (Used only once for authentication code issuance)Click the Save and Continue button to confirm the configured content and then click
Back to Dashboardat the bottom.
User Credentials Configuration (OAuth Client ID)
In the left panel, go to the Credentials menu.
Click the
Create Credentialsbutton at the top and then clickOAuth client ID.For Application type, select
Web application.In the Authorized redirect URIs section, add the URL below:
https://developers.google.com/oauthplayground
Click the
Createbutton.From the creation result screen, copy the Client ID, Client Secret, and Redirect URI.
Registering OAuth Client ID in NAC Management Console
- Log in to the Policy Server management console.
- Go to the Settings menu at the top.
- In the left panel, go to Preferences > Other Settings.
- Go to the Google API Client ID and Authentication Key Settings section at the bottom.
- Enter the Client ID, Client Authentication Key, and Authorized Redirect URI, then click the
Updatebutton at the bottom.
Configuring NAC Data Synchronization
- Go to Preferences in the top menu.
- In the left settings menu, go to User Authentication > Data Synchronization.
- Click Select Tasks > Create.
General options
ID : Enter a unique name.
Update Interval : Select a specified time or periodic interval for synchronization.
Policy Apply : select
Enabledfor applying change after Synchronization. If there are several synchronization settings, you can set it to Disabled and enable only the last one.Environment : Input is not required for basic synchronization tasks. However, it is used when defining variable values to be commonly referenced within a separate custom shell script executed for integration with external systems.
Warning
Configuration Caution: Incorrect environment variable declarations can lead to malfunctions in the integration script or system errors. Before configuration, please ensure that the variables are correctly processed within the script.
Usage Scenario: Log Level Control Used when you want to control simple operation options such as Log Level or Retry Count during external script execution.
export LOG_LEVEL='ERROR'
Query : Enter the SQL query to be executed immediately after information synchronization is complete. This is used when secondary processing is required based on specific conditions using the synchronized information.
Warning
Risk of Data Loss: This feature directly affects the database. In particular, the use of
UPDATEorDELETEstatements may result in irreversible data loss.Usage Scenario: Account Lock Processing based on Employment Status Used when you want to automatically disable the NAC account of resigned (or on-leave) employees according to the 'Employment Status' code after information synchronization.
Prerequisites 1. Create a field to manage employment status (e.g., USER_CUSTOM08) in [Settings] > [Property Management] > [Custom Fields] > [User Custom Fields]. 2. Assign the user custom field created in step 1 to [Additional Info] under [User Information] in [Information Synchronization].
Writing Example If the value of USER_CUSTOM08 is '001' (Resigned/On-leave, etc.), update USER_STATUS to '0' (Disabled).
UPDATE USER SET USER_STATUS = 0 WHERE USER_CUSTOM08 = '001';
Database options
- DB Type:
Google G Suite - Google Auth Code: Enter the code for authentication of the synchronization execution account. Click the
Get Google Auth Codebutton at the top, then log in to the account and click theAllowbutton in the pop-up window, then copy the displayedAuthorization codeand enter it. (Close the pop-up window.) - DOMAIN: If a domain is entered, only information for that domain will be synchronized. If not entered, information for all domains to which the account belongs will be synchronized.
- VIEW TYPE: Select the data synchronization scope based on permissions. Generally, select
admin_viewfor accounts with admin privileges, anddomain_publicotherwise.
User Information options
- User Table Name: Enter
users. - User ID Column Name: Enter
primaryEmail. - User Name Column Name: Enter
name/fullName. - Department ID Column Name: Enter
orgUnitPath.
Department Information options
- Table Name: Enter
orgunits. - Output Sort Order: To sort by department name, enter
@NAMEPATH. - Department ID Column Name: Enter
orgUnitId. - Department Name Column Name: Enter
name. - Parent Department Column Name: Enter
parentOrgUnitId. - Click the Create button.
Attention
G Suite does not provide the password attribute when using the API, so user passwords cannot be synchronized. Therefore, a separate integration must be configured. Refer to SAML 2.0 in Integrating User Directories.
