Skip to main content

Administrator Guide


  • A Google Apps account for your organization. This will not work with a standard gmail account.
  • Administrator rights to both the Google Apps account and Confluence
  • Scaffolding and Reporting plugins

Setting up Google Service Account

For additional information about this see Google's Using OAuth 2.0 for Server to Server Applications page

  1. Open the Credentials page for your account
  2. Create a new project.

  3. Click on the Create credentials button
  4. Create a new service account by specifying you will be calling Contacts API from a web server
  5.  Give the service account a name and a role. The role can be Viewer since you will only need to read data from Google.
  6. When prompted for a key type, select "P12". A file should automatically download. This is the p12 key file. Keep it in a secure place and do not rename it.
  7. When complete, click into the account
    1. Note the email address and client ID
    2. If the p12 file did not download in step 4, click "Generate new P12 key" and save the file in a secure place
  8. On the navigation on the left side, click on the "Overview" link
  9. Find the "Contacts API" link in the Google Apps APIs section and click on it
  10. Click the "Enable API" button

Authorizing the Google Account

This will grant your service account access to data belonging to any member of your organization. Make sure you only authorize the necessary APIs and keep your key files secure.

  1. Go to your Google Apps domain’s Admin console.
  2. Select Security from the list of controls. If you don't see Security listed, select More controls from the gray bar at the bottom of the page, then select Security from the list of controls. If you can't see the controls, make sure you're signed in as an administrator for the domain.
  3. Select Show more and then Advanced settings from the list of options.
  4. Select Manage API client access in the Authentication section.
  5. In the Client Name field enter the service account's Client ID.
  6. In the One or More API Scopes field enter the scope values for the services you wish to connect. You will need to enter them all together, separated by commas.

  7. Click Authorize.

Configuring the Google Connector

  1. Go to the Confluence administration console
  2. Click on the Google Contacts link
  3. Under the file upload section, click "Choose file" and locate the p12 file you downloaded earlier.
  4. Click "Upload"
  5. Next to Service Account ID, enter the service account's email address.
  6. Click "Save" 
  7. In the accounts table, link one or more accounts:
    1. Under User, enter a user's full account ID (
    2. Under Group, enter the group ID that you want to to load for that user. Only contacts assigned to this group will be available in Confluence.{

      Order matters! If the same contact exists in multiple accounts, priority will be given to the first account with that contact.

  8. Click "Save"

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.