---
product: Chilkat
product_version: 11.7.0
language: js
language_label: JavaScript
class: AuthGoogle
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/jsAuthGoogleRef.html
---
# Chilkat AuthGoogle — JavaScript — v11.7.0

> Chilkat 11.7.0 · language=js · class=AuthGoogle
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/AuthGoogle.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/guide.md`.

## Purpose

**Obtain Google OAuth 2.0 access tokens using a service account.**

`Chilkat.AuthGoogle` obtains OAuth 2.0 access tokens for Google Cloud Platform APIs and Google Apps APIs using a Google service account. It supports JSON private keys and P12 private keys, OAuth scopes, optional delegated user access, custom JWT claims, access-token validity tracking, token lifetime settings, and integration with Chilkat request classes that need a Google bearer token.

**Service account auth**

Authenticate server-to-server using a Google service account rather than an interactive browser-based user consent flow.

**JSON or P12 keys**

Load service account credentials from modern JSON private keys or from legacy P12 private key files.

**Scopes and claims**

Specify the OAuth scopes required by the target Google API and add custom JWT claims when needed.

**Delegated user access**

Use domain-wide delegation by setting a subject email when the service account is authorized to act on behalf of a Google Workspace user.

**Access-token tracking**

Inspect the generated access token, expiration time, remaining lifetime, and validity state before using or refreshing credentials.

**Chilkat API integration**

Pass the resulting bearer token to Chilkat HTTP, REST, storage, mail, or other Google API request workflows.

**Common pattern:** Load the service account JSON key or P12 key, set the service account email, required `Scope`, optional delegated `SubEmailAddress`, and token lifetime, then call `ObtainAccessToken`. Use `AuthGoogle` for service-account OAuth flows; use `Chilkat.OAuth2` when the application needs an interactive three-legged OAuth flow involving a user's browser consent.

For an extended overview, see [AuthGoogle Class Overview](https://www.chilkatsoft.com/authgoogle_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

Note: This is intended for running within a [Chilkat.Js embedded JavaScript engine](https://www.chilkatsoft.com/chilkat_javascript_engine.asp).

```
var obj = new CkAuthGoogle();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in JavaScript.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `LastErrorHtml` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `VerboseLogging` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AccessToken` | property, read/write | `AccessToken` |
| `EmailAddress` | property, read/write | `EmailAddress` |
| `ExpireNumSeconds` | property, read/write | `ExpireNumSeconds` |
| `Iat` | property, read/write | `Iat` |
| `JsonKey` | property, read/write | `JsonKey` |
| `NumSecondsRemaining` | property, read-only | `NumSecondsRemaining` |
| `Scope` | property, read/write | `Scope` |
| `SubEmailAddress` | property, read/write | `SubEmailAddress` |
| `Valid` | property, read-only | `Valid` |
| `AddClaims` | method | `var success = AddClaims(json);` |
| `ObtainAccessToken` | method | `var success = ObtainAccessToken(connection);` |
| `SetP12` | method | `var success = SetP12(key);` |

## Properties

### AuthGoogle.AccessToken

`Chilkat 11.7.0 · js · AuthGoogle · AccessToken · property · read/write · since 9.5.0.58`

```javascript
AccessToken
```

· `string`

The access token to be used in Google API requests. This property is set on a successful call to ObtainAccessToken.

**Important:** This class is used for authenticating calls to the Google Cloud Platform API and Google Apps API using a **service account.**. For 3-legged OAuth2, where a browser must be used to interactively get permission from the Google account owner, use the Chilkat OAuth2 class/object.

### AuthGoogle.EmailAddress

`Chilkat 11.7.0 · js · AuthGoogle · EmailAddress · property · read/write · since 9.5.0.58`

```javascript
EmailAddress
```

· `string`

The client email address of the service account. If a JSON key is used, then the client_email should already be specified within the JSON key, and this property is unused. This property must be set if using a P12 key.

### AuthGoogle.ExpireNumSeconds

`Chilkat 11.7.0 · js · AuthGoogle · ExpireNumSeconds · property · read/write · since 9.5.0.58`

```javascript
ExpireNumSeconds
```

· `int`

The expiration time, in seconds, of the access token to be requested. The maximum value is 1 hour (3600 seconds). The default value is 3600.

### AuthGoogle.Iat

`Chilkat 11.7.0 · js · AuthGoogle · Iat · property · read/write · since 9.5.0.77`

```javascript
Iat
```

· `int`

This property can be set to override the default current date/time value for the `iat` claim of the JWT. It can be set to a value indicating the number of seconds from 1970-01-01T00:00:00Z UTC.

The default value is 0, which indicates to use the iat value for the current system date/time. Unless explicitly needed, always leave this property at the default value.

### AuthGoogle.JsonKey

`Chilkat 11.7.0 · js · AuthGoogle · JsonKey · property · read/write · since 9.5.0.58`

```javascript
JsonKey
```

· `string`

The JSON key for obtaining an access token. An application must set either the P12 or JSON private key, but not both.

### AuthGoogle.NumSecondsRemaining

`Chilkat 11.7.0 · js · AuthGoogle · NumSecondsRemaining · property · read-only · since 9.5.0.58`

```javascript
NumSecondsRemaining
```

· `int`, `read-only`

If the access token is valid, contains the number of seconds remaining until it expires. A value of 0 indicates an invalid or expired access token.

### AuthGoogle.Scope

`Chilkat 11.7.0 · js · AuthGoogle · Scope · property · read/write · since 9.5.0.58`

```javascript
Scope
```

· `string`

A space-delimited list of the permissions that the application requests.

### AuthGoogle.SubEmailAddress

`Chilkat 11.7.0 · js · AuthGoogle · SubEmailAddress · property · read/write · since 9.5.0.58`

```javascript
SubEmailAddress
```

· `string`

The email address of the user for which the application is requesting delegated access.

### AuthGoogle.Valid

`Chilkat 11.7.0 · js · AuthGoogle · Valid · property · read-only · since 9.5.0.58`

```javascript
Valid
```

· `boolean`, `read-only`

`true` if the AccessToken property contains a valid non-expired access token obtained via the call to ObtainAccessToken.

## Methods

### AuthGoogle.AddClaims

`Chilkat 11.7.0 · js · AuthGoogle · AddClaims · method · since 9.5.0.99`

```javascript
var success = AddClaims(json);
```

· return: `boolean`; `true` for success, `false` for failure  
· json: `CkJsonObject`

Adds additional custom claims to the JWT claims set.

Returns true for success, false for failure.

### AuthGoogle.ObtainAccessToken

`Chilkat 11.7.0 · js · AuthGoogle · ObtainAccessToken · method · since 9.5.0.58`

```javascript
var success = ObtainAccessToken(connection);
```

· return: `boolean`; `true` for success, `false` for failure  
· connection: `CkSocket`

Sends the HTTP request to fetch the access token. When this method completes successfully, the access token is available in the AccessToken property. The `connection` is an existing connection to www.googleapis.com.

**Important:** Make sure your computer's date/time is accurately set to the current date/time, otherwise you'll get a 400 response status code with this error: `Invalid JWT: Token must be a short-lived token (60 minutes) and in a reasonable timeframe. Check your iat and exp values and use a clock with skew to account for clock differences between systems.`.

Returns true for success, false for failure.

### AuthGoogle.SetP12

`Chilkat 11.7.0 · js · AuthGoogle · SetP12 · method · since 9.5.0.58`

```javascript
var success = SetP12(key);
```

· return: `boolean`; `true` for success, `false` for failure  
· key: `CkPfx`

Sets the P12 private key to be used for obtaining an access token. An application must set either the P12 or JSON private key, but not both.

Returns true for success, false for failure.

## Events and callbacks

This binding has no event callbacks.

## Related classes

[`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/JsonObject.md), [`Pfx`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/Pfx.md), [`Socket`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/Socket.md)