Chat now with support
Chat with Support

Identity Manager 8.1.5 - Administration Guide for Connecting to G Suite

Mapping G Suite in One Identity Manager Synchronizing G Suite Managing G Suite user accounts and employees Provision of login information for G Suite user accounts Managing G Suite entitlement assignments Mapping of G Suite objects in One Identity Manager
G Suite customers G Suite user accounts G Suite groups G Suite products and SKUs G Suite organizations G Suite domains G Suite domain aliases G Suite admin roles G Suite admin privileges G Suite admin role assignments Reports about G Suite objects
Handling of G Suite objects in the Web Portal Basic data for managing G Suite Troubleshooting the connection to a G Suite environment Configuration parameters for managing G Suite Default project templates for G Suite API scopes for the service account Processing G Suite system objects Special features in the assignment of G Suite groups About us

Information required for setting up a synchronization project

Have the following information available for setting up a synchronization project.

Table 5: Information required for setting up a synchronization project

Data

Explanation

Primary domain

Name of this G Suite's primary domain.

Service account's key file

JSON key file that was saved when the service account was set up .

Super admin email addresses for logging in

You can enter up to eight super administrators for using to synchronize G Suite. The more that are entered, the more accesses can be done in parallel. This improves the total runtime of a request.

Provide at least one user with super administrator permissions. For more information, see Users and permissions for synchronizing with G Suite.

Synchronization server for G Suite

All One Identity Manager Service actions are executed against the target system environment on the synchronization server. Data entries required for synchronization and administration with the One Identity Manager database are processed by the synchronization server.

The One Identity Manager Service with the G Suite connector must be installed on the synchronization server.

Table 6: Additional properties for the Job server
Property Value
Server function G Suite connector
Machine role Server/Job server/G Suite

For more information, see System requirements for the G Suite synchronization server.

One Identity Manager database connection data

  • Database server

  • Database

  • SQL Server login and password

  • Specifies whether integrated Windows authentication is used. This type of authentication is not recommended. If you decide to use it anyway, ensure that your environment supports Windows authentication.

Remote connection server

To configure synchronization with a target system, One Identity Manager must load the data from the target system. One Identity Manager communicates directly with the target system to do this. Sometimes direct access from the workstation, on which the Synchronization Editor is installed, is not possible. For example, because of the firewall configuration or the workstation does not fulfill the necessary hardware and software requirements. If direct access is not possible from the workstation, you can set up a remote connection.

The remote connection server and the workstation must be in the same Active Directory domain.

Remote connection server configuration:

  • One Identity Manager Service is started

  • RemoteConnectPlugin is installed

  • G Suite connector is installed

The remote connection server must be declared as a Job server in One Identity Manager. The Job server name is required.

TIP: The remote connection server requires the same configuration as the synchronization server (with regard to the installed software and entitlements). Use the synchronization as remote connection server at the same time, by simply installing the RemoteConnectPlugin as well.

For more detailed information about setting up a remote connection, see the One Identity Manager Target System Synchronization Reference Guide.

Creating an initial synchronization project for G Suite

NOTE: The following sequence describes how to configure a synchronization project if the Synchronization Editor is both:

  • Executed in default mode

  • Started from the Launchpad

If you execute the project wizard in expert mode or directly from the Synchronization Editor, additional configuration settings can be made. Follow the project wizard instructions through these steps.

To set up an initial synchronization project for G Suite

  1. Start the Launchpad and log in to the One Identity Manager database.

    NOTE: If synchronization is executed by an application server, connect the database through the application server.

  2. Select the Target system type G Suite entry and click Start.

    This starts the Synchronization Editor's project wizard.

  1. On the System access page, specify how One Identity Manager can access the target system.

    • If access is possible from the workstation on which you started the Synchronization Editor, do not change any settings.

    • If access is not possible from the workstation on which you started the Synchronization Editor, you can set up a remote connection.

      Enable the Connect using remote connection server option and select the server to be used for the connection under Job server.

  1. On the Primary domain and service account page, enter the primary domain of the G Suite account and the key file for the service account.
    Table 7: Login information for connection to G Suite
    Property Description
    Primary domain

    Name of this G Suite's primary domain.

    Service account's key file

    JSON key file saved when the service account was set up.

    • Drag and drop the key on the field to load it.

      - OR -

    • Click Open key file and select the path to the key file.

  2. On the G Suite Administrators page, enter the email addresses of all the super administrators who can use the G Suite connector for logging into the target system.

    You can enter up to eight super administrators. The more that are entered, the more accesses can be done in parallel. This improves the total runtime of a request.

    • Click Test connection to test the connection data.

      All administrator accounts are verified and a check is run on whether the correct API scopes are authorized.

  3. Specify, on the Local cache page, whether the G Suite connector's local cache should be used. This minimizes the number of times G Suite is accessed during full synchronization. It prevents the API contingent from being exceeded through synchronization.

    This option is set by default and should only be disabled for troubleshooting.

  4. You can save the connection data on the last page of the system connection wizard.
    • Set the Save connection locally option to save the connection data. This can be reused when you set up other synchronization projects.
    • Click Finish, to end the system connection wizard and return to the project wizard.

  1. On the One Identity Manager Connection tab, test the data for connecting to the One Identity Manager database. The data is loaded from the connected database. Reenter the password.

    NOTE: If you use an unencrypted One Identity Manager database and have not yet saved any synchronization projects to the database, you need to enter all connection data again. This page is not shown if a synchronization project already exists.

  2. The wizard loads the target system schema. This may take a few minutes depending on the type of target system access and the size of the target system.

  1. On the Restrict target system access page, specify how system access should work. You have the following options:
    Table 8: Specify target system access
    Option Meaning

    Read-only access to target system.

    Specifies that a synchronization workflow is only to be set up for the initial loading of the target system into the One Identity Manager database.

    The synchronization workflow has the following characteristics:

    • Synchronization is in the direction of One Identity Manager.
    • Processing methods in the synchronization steps are only defined for synchronization in the direction of One Identity Manager.

    Read/write access to target system. Provisioning available.

    Specifies whether a provisioning workflow is to be set up in addition to the synchronization workflow for the initial loading of the target system.

    The provisioning workflow displays the following characteristics:

    • Synchronization is in the direction of the Target system.
    • Processing methods are only defined in the synchronization steps for synchronization in the direction of the Target system.
    • Synchronization steps are only created for such schema classes whose schema types have write access.
  1. On the Synchronization server page, select a synchronization server to execute synchronization.

    If the synchronization server is not declared as a Job server in the One Identity Manager database yet, you can add a new Job server.

    1. Click to add a new Job server.

    2. Enter a name for the Job server and the full server name conforming to DNS syntax.

    3. Click OK.

      The synchronization server is declared as a Job server for the target system in the One Identity Manager database.

      NOTE: After you save the synchronization project, ensure that this server is set up as a synchronization server.
  1. To close the project wizard, click Finish.

    This creates and allocates a default schedule for regular synchronization. Enable the schedule for regular synchronization.

    The synchronization project is created, saved, and enabled immediately.

    NOTE: If enabled, a consistency check is carried out. If errors occur, a message appears. You can decide whether the synchronization project can remain activated or not.

    Check the errors before you use the synchronization project. To do this, in the General view on the Synchronization Editor‘s start page, click Verify project.

    NOTE: If you do not want the synchronization project to be activated immediately, disable the Activate and save the new synchronization project automatically option. In this case, save the synchronization project manually before closing the Synchronization Editor.

    NOTE: The connection data for the target system is saved in a variable set and can be modified in the Configuration | Variables category in the Synchronization Editor.
Related topics

Configuring the synchronization log

All the information, tips, warnings, and errors that occur during synchronization are recorded in the synchronization log. You can configure the type of information to record separately for each system connection.

To configure the content of the synchronization log

  1. To configure the synchronization log for target system connection, select the Configuration | Target system category in Synchronization Editor.

    - OR -

    To configure the synchronization log for the database connection, select the Configuration | Synchronization Editor connection category in One Identity Manager.

  2. Select the General view and click Configure.

  3. Select the Synchronization log view and set Create synchronization log.

  4. Enable the data to be logged.

    NOTE: Some content generates a particularly large volume of log data!

    The synchronization log should only contain data required for error analysis and other analyzes.

  5. Click OK.

Synchronization logs are stored for a fixed length of time.

To modify the retention period for synchronization logs

  • In the Designer, enable the DPR | Journal | LifeTime configuration parameter and enter the maximum retention period.

Related topics

Adjusting the synchronization configuration for G Suite environments

Having used the Synchronization Editor to set up a synchronization project for initial synchronization of a customer, you can use the synchronization project to load G Suite objects into the One Identity Manager database. If you manage user accounts and their authorizations with One Identity Manager, changes are provisioned in the G Suite.

NOTE: If you want to change the configuration of existing synchronization projects, check the possible effects of these changes on the data that has already been synchronized.

You must customize the synchronization configuration in order to compare the database with G Suite regularly and to synchronize changes.

  • To use One Identity Manager as the master system during synchronization, create a workflow with synchronization in the direction of the Target system.
  • To specify which G Suite objects and database objects are included in synchronization, edit the scope of the target system connection and the One Identity Manager database connection. To prevent data inconsistencies, define the same scope in both systems. If no scope is defined, all objects will be synchronized.
  • You can use variables to create generally applicable synchronization configurations that contain the necessary information about the synchronization objects when synchronization starts. Variables can be implemented in base objects, schema classes, or processing methods, for example.
  • Use variables to set up a synchronization project for synchronizing different customers. Store a connection parameter as a variable for logging in to the respective G Suite customer.
  • Update the schema in the synchronization project if the One Identity Manager schema or target system schema has changed. Then you can add the changes to the mapping.

  • To synchronize additional schema properties, update the schema in the synchronization project. Include the schema extensions in the mapping.

  • Add your own schema types if you want to synchronize data, which does not have schema types in the connector schema. Include the schema extensions in the mapping.

For more detailed information about configuring synchronization, see the One Identity Manager Target System Synchronization Reference Guide.

Detailed information about this topic
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating