Set up Password Sync

3. Create a service account

If you’re using 3-legged OAuth as your Google authentication method, you can skip this step and go to Download & install.

To use a service account as your authentication method for Password Sync, you need to create an account and set it up before you install Password Sync. How you create the account depends on whether you want to run an automated script (recommended) or manually create a service account.

You're on step 3 of 6

"" "" "" "" "" ""

Option 1: Use an automated script to create the account

This GitHub script is not supported by Google Workspace support. If you have issues using the script, follow the steps to manually create the account instead.

  1. Sign in as a super administrator and, in a browser window, open Cloud Shell.
  2. In the editor, enter python3 <(curl -s -S -L https://git.io/password-sync-create-service-account).
  3. Complete the steps in the Cloud Shell window.
  4. Click Download to download the JSON file that contains the service account's client ID to your computer.
  5. Go to Download & install.

Learn more about using the script.

Option 2: Manually create a service account

Expand all  |  Collapse all

Step 1: Create a project
  1. Go to Google Cloud and sign in as a super administrator. If it's your first time signing in to the console, agree to the Terms of Service.
  2. Click IAM & Adminand thenManage Resources. You might have to click Menu "" first.
  3. At the top, click Create Project and enter a project name.
  4. (Optional) To add the project to a folder, for Location, click Browse, navigate to the folder, and click Select.
  5. Click Create.
  6. By default, only the creator of the project has rights to manage the project. To ensure the project can be maintained if the creator leaves the organization, you should assign at least one other person the role of Project Owner. For details, go to Manage access to projects, folders, and organizations.
Step 2: Turn on the APIs for the service account
  1. Check the box next to your new project.
  2. Click APIs & Servicesand thenLibrary. You might have to click Menu "" first.
  3. Search for the Admin SDK API and click the API name and then Enable.
Step 3: Set up the OAuth consent screen

Tip: When adding the email addresses below, use shared administrator email accounts.

  1. Click APIs & Servicesand thenOAuth consent screen. You might have to click Menu "" first.
  2. For User Type, select Internal.
  3. Click Create.
  4. For App name, add the name of your application. 
  5. Select a User support email for users to contact with questions.
  6. For Developer contact information, enter email addresses so Google can contact you about changes to your project.
  7. Click Save and Continueand thenSave and Continueand thenBack to Dashboard.
Step 4: Create the service account
  1. Click APIs & Servicesand thenCredentials. You might have to click Menu "" first.
  2. Click Create Credentialsand thenService account.
  3. For Service account name, enter a name for the service account and optionally add a description. 
  4. Click Create and Continueand thenDone.
  5. Make a note of the Unique ID value for the service account. You'll need it later. This value is also the service account’s client ID.

    Tip: You can also find the value on the Details tab of the service account or in the JSON file.

  6. Click Doneand thenSave.
  7. At the top, click Keysand thenAdd Keyand thenCreate new key.
  8. Make sure the key type is set to JSON and click Create.

    You'll get a message that the service account's private key JSON file was downloaded to your computer.

  9. Make a note of the file name and where your browser saves it. You'll need it later.
  10. Click Close.
Step 5: Authorize your client ID in the Admin console
You must be signed in as a super administrator for this task.
  1. Sign in to your Google Admin console.

    Sign in using an account with super administrator privileges (does not end in @gmail.com).

  2. In the Admin console, go to Menu ""and then"" Securityand thenAccess and data controland thenAPI controls.
  3. Click Manage Domain Wide Delegation.
  4. Click Add new and enter your service account client ID.

    You can find the ID (also known as the Unique ID) in the JSON file that you downloaded when you created the service account or in Google Cloud (click IAM & Adminand thenService accountsand thenthe name of your service account).

  5. In the OAuth scopes field, enter https://www.googleapis.com/auth/admin.directory.user.
  6. Click Authorize.

Next step


Google, Google Workspace, and related marks and logos are trademarks of Google LLC. All other company and product names are trademarks of the companies with which they are associated.

Was this helpful?
How can we improve it?

Need more help?

Sign in for additional support options to quickly solve your issue

Search
Clear search
Close search
Google apps
Main menu
Search Help Center
true
73010
false
false