Creating a Custom OAuth App
You can authorize the adapter to access Google APIs on behalf of individual users or on behalf of a domain. Use the OAuth authentication standard to connect to Google APIs.
Using a User Account to Connect to Google Contacts
This OAuth flow requires the authenticating user to interact with Google Contacts using the browser. The adapter facilitates this in various ways as described below.
Authenticate to Google Contacts
Set InitiateOAuth to "GETANDREFRESH" to avoid manually generating the OAuthAccessToken connection property and repeating the OAuth exchange. When you connect the adapter opens the OAuth endpoint in your default browser. Log in and grant permissions to the application.
The adapter then completes the OAuth process:
- Extracts the access token from the callback URL and authenticates requests.
- Refreshes the access token when it expires.
- Saves OAuth values to be persisted across connections. You can configure this file with OAuthSettingsLocation.
Using a Service Account to Connect to Domain-Wide DataYou 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 adapter obtains an OAuthAccessToken to authenticate that it has the same scope of access to Google APIs as the service account. The adapter 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:
- Log into the Google API Console and open a project. Select the API Manager from the main menu.
- Click Credentials -> Create Credentials -> Service Account Key.
- In the Service Account menu, select New Service Account or select an existing service account.
- 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.
- In the Key Type section, select the P12 key type.
- Download the key pair. The private key's password is displayed: Set this in OAuthJWTCertPassword.
- 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.
- 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.
- Creates and signs the JWT with the claim set required by the adapter.
- Exchanges the JWT for the access token.
- Submits the JWT for a new access token when the token expires.