How to integrate G Suite Directory with Sapho version 3.9 or greater

Last update:

Important Notes

1. We recommend creating a dedicated Google account (for example, and then using it to set up the G Suite Directory integration in Sapho. Assign to this dedicated user account the following privileges: Read Users and Read Groups Admin API.

2. If your internal server hosting Sapho is behind a firewall, you will need to allow access to hostname with port 443, so Sapho can connect to G Suite Directory.

Step 1: Sign in

Log in to with the dedicated user account.

Step 2: Create a Google API project

Go to the Google API console. Click the down arrow next to Google APIs logo in the top bar.


On the popup, click the + button to create a new project.


Add a project name and click the Create button.

Wait a while until you are redirected to the new project.

Step 3: Create OAuth credentials

Go to the Credentials tab. Click Create Credentials and select OAuth Client ID.


You will be redirected to a new page. Click the Configure consent screen button.

In the Product name shown to users input add a product name. Then click Save at the bottom of the page.


You will be redirected to a new page. Set Application type to Web Application and then set Authorized redirect URIs to


Step 4: Get the client credentials

Click the Create button. A pop-up with your Client OAuth credentials will appear. Copy & paste the values in a secure place for later reference.

Step 5: Enable the Admin SDK

Go to the Library tab and search for Google Apps APIs > Admin SDK and select it.

Hit the Enable button at the top of the page.


For more information about Admin SDK authorisation see see Google’s Directory API documentation.

Step 6: Paste the credentials in Sapho

Paste the client ID and client secret in the Data form for G Suite Directory in Sapho. Click Next.

Step 7: Log in with the dedicated Google account

Click Next.

Step 8: Finish the creation of the integration