For the following setup, it's recommended to perform it in a browser where you're just logged into the Google account you are using for configuring GSuite.
Other Google sessions might make it hard for you to walk through the setup sucessfully, especially when authorizing the Gsuite app from inside the connector configiuration.

This page contains information for how to setup User Sync and G Suite. Note, it is recommend to follow the video or the detailed User guide. If you are familiar with setting up G Suite projects, feel free to follow the Quick start guide.



Quick start guide

  1. Login to the Google API Console. Click on the current active project.
  2. Click on "NEW PROJECT".
  3. Enter a "Project Name" and click on "CREATE". For this tutorial, it is calls "Test Project". This can take a second.
  4. In the next window, click on your just created new project.
  5. After opening your project, click on "API library".
  6. In the search bar, type "Admin SDK" and click on the "Admin SDK".
  7. On the next page click on "ENABLE".
  8. Now, click on "Credentials" in the left panel.
  9. Afterwards, click on "+ CREATE CREDENTIAL".
  10. Click on "Create credentials" and choose "OAuth client ID".
  11. Click on "Configure consent screen" on the right side of your window.
  12. Choose an "Application type" (see https://developers.google.com/identity/protocols/googlescopes?hl=en_US) and enter an "Application name".
  13. Scroll down to "Authorized domains" and enter your personal domain, e.g. "mycompany.com". Press the ENTER key to add the domain.
  14. Press "Save" to save your configuration.
  15. In next window, tick "Web application". Also enter an  "Authorized redirect URIshttps://<your-atlassian-product-base-url>/plugins/servlet/de.resolution.usersync/oauth2/authorize and press the ENTER key  confirm.
  16. Double check that you have pressed the ENTER key. Afterwards, press "Save".
  17. In the next window you can see your "client ID" and your "client secret". You will need both for setting up User Sync, thus save them somewhere where you can find them for the next step
  18. Now User Sync will be setup in your Atlassian application. Press "Add Connector" and choose "G Suite Connector".
  19. Enter your the "Domain" of your G Suite instance, enter your "Client ID" and "Client Secret" from step 17. Click on "Authorize".
  20. The plugin will show you if the authorization was successful.
  21. Your configuration is now done, scroll down and click on "Save".
  22. You are now ready for your first sync. Click on "Sync" in the Connector overview. 



User guide

Login to the Google API Console. Click on the current active project.



Click on "NEW PROJECT".




Enter a "Project Name" and click on "CREATE". For this tutorial, it is calls "Test Project". This can take a second.




In the next window, click on your just created new project.



After opening your project, click on "API library".



In the search bar, type "Admin SDK" and click on the "Admin SDK".



On the next page click on "ENABLE".



Now, click on "Credentials" in the left panel.



Now, click on "+ CREATE CREDENTIAL".



Now, click on "Create credentials" and choose "OAuth client ID".



Click on "Configure consent screen".



Choose an "Application type" (see https://developers.google.com/identity/protocols/googlescopes?hl=en_US) and enter an "Application name".



Scroll down to "Authorized domains" and enter your personal domain, e.g. "mycompany.com". Press the ENTER key to add the domain.



Again, do not forget to press the ENTER key.  Press "Save" to save your configuration.



In next window, tick "Web application". Also enter an  "Authorized redirect URIshttps://<your-atlassian-product-base-url>/plugins/servlet/de.resolution.usersync/oauth2/authorize and press the ENTER key  confirm.



Double check that you have pressed the ENTER key. Afterwards, press "Save".



In the next window you can see your "client ID" and your "client secret". You will need both for setting up User Sync, thus save them somewhere where you can find them for the next step.



Now User Sync will be setup in your Atlassian application. Press "Add Connector" and choose "G Suite Connector".



Enter your the "Domain" of your G Suite instance, enter your "Client ID" and "Client Secret" from step 17. Click on "Authorize".



If the authorization was successful, you will see the following. 


To take the full advantages of User Sync, scroll down and tick "Enable Scheduled Synchronization". You can control the sync interval via a Cron Expression.

Do not forget to save your configuration. Scroll down to the bottom of the page and hit "Save".



You are now ready for your first sync. Click on "Sync".