Google Contacts

GoogleContacts uses the OAuth authentication standard. You can use OAuth to authorize the provider to access Google APIs on behalf of individual users or on behalf of users in a domain.

Using a User Account to Authenticate to GoogleContacts

The user account flow requires the authenticating user to interact with GoogleContacts via the browser.

Using a Service Account to Connect to GoogleContacts

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the provider.

You need to create an OAuth application in this flow. You can then connect to GoogleContacts data that the service account has permission to access.

To obtain an OAuthAccessToken, you need to register an app and set the following connection properties.

  • OAuthClientId: Set this to the client Id in your app settings.

  • OAuthClientSecret: Set this to the client secret in your app settings.

Using a Service Account to Connect to Domain-Wide Data

You can use a service account in this OAuth flow to access Google APIs on behalf of users in a domain. A domain administrator must delegate domain-wide access to the service account.

To complete the service account flow, you need to generate a private key in the Google APIs Console. In the service account flow, the provider obtains an OAuthAccessToken to authenticate that it has the same scope of access to Google APIs as the service account. The provider exchanges a JSON Web token (JWT) to obtain the access token. The private key is required to sign the JWT.

Generate a Private Key

If you are connecting from a service account, follow the steps below:

  1. Log into the Google API Console and open a project. Select the API Manager from the main menu.

  2. Click Credentials -> Create Credentials -> Service Account Key.

  3. In the Service Account menu, select New Service Account or select an existing service account.

  4. If you are creating a new service account, additionally select one or more roles. You can assign primitive roles at the project level in the IAM and Admin section; other roles enable you to further customize access to Google APIs.

  5. In the Key Type section, select the P12 key type.

  6. Download the key pair. The private key's password is displayed: Set this in OAuthJWTCertPassword.

  7. In the Service Account Keys section on the Credentials page, click Manage Service Accounts and set OAuthJWTIssuer to the email address displayed in service account Id.

  8. In the API Manager, click Library and enable the Drive, Calendar, and Contacts APIs. To enable an API, click the API and then click Enable API.

Authenticate with a Service Account

After setting the following connection properties, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.

  • OAuthJWTCertType: Set this to "PFXFILE".

  • OAuthJWTCertPassword: Set this to the password of the .p12 file.

  • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.

  • OAuthJWTIssuer: Set this to the email address of the service account.

  • OAuthJWTCert: Set this to the path to the .p12 file.

  • OAuthJWTSubject: Set this to the email address of the user for whom the application is requesting delegate access.

When you connect the provider completes the OAuth flow for a service account:

  1. Creates and signs the JWT with the claim set required by the provider.

  2. Exchanges the JWT for the access token.

  3. Submits the JWT for a new access token when the token expires.

Last updated