---
product: Chilkat
product_version: 11.7.0
language: wc
language_label: Unicode C
class: AuthGoogle
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/wc_CkAuthGoogleWRef.html
---
# Chilkat AuthGoogle — Unicode C — v11.7.0

> Chilkat 11.7.0 · language=wc · 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/wc/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

**Create/Dispose**

```c
HCkAuthGoogleW instance = CkAuthGoogleW_Create();
// ...
CkAuthGoogleW_Dispose(instance);
```

`HCkAuthGoogleW CkAuthGoogleW_Create(void);`

Creates an instance of the HCkAuthGoogleW object and returns a handle ("void \*" pointer). The handle is passed in the 1st argument for the functions listed on this page.

`void CkAuthGoogleW_Dispose(HCkAuthGoogleW handle);`

Objects created by calling CkAuthGoogleW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkAuthGoogleW_Dispose.

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 Unicode C.

## 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` | `void CkAuthGoogleW_getDebugLogFilePath(HCkAuthGoogleW cHandle, HCkString retval); void CkAuthGoogleW_putDebugLogFilePath(HCkAuthGoogleW cHandle, const wchar_t *newVal); const wchar_t *CkAuthGoogleW_debugLogFilePath(HCkAuthGoogleW cHandle);` | 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` | `void CkAuthGoogleW_getLastErrorHtml(HCkAuthGoogleW cHandle, HCkString retval); const wchar_t *CkAuthGoogleW_lastErrorHtml(HCkAuthGoogleW cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkAuthGoogleW_getLastErrorText(HCkAuthGoogleW cHandle, HCkString retval); const wchar_t *CkAuthGoogleW_lastErrorText(HCkAuthGoogleW cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkAuthGoogleW_getLastErrorXml(HCkAuthGoogleW cHandle, HCkString retval); const wchar_t *CkAuthGoogleW_lastErrorXml(HCkAuthGoogleW cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkAuthGoogleW_getLastMethodSuccess(HCkAuthGoogleW cHandle); void CkAuthGoogleW_putLastMethodSuccess(HCkAuthGoogleW cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `VerboseLogging` | `BOOL CkAuthGoogleW_getVerboseLogging(HCkAuthGoogleW cHandle); void CkAuthGoogleW_putVerboseLogging(HCkAuthGoogleW cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkAuthGoogleW_getVersion(HCkAuthGoogleW cHandle, HCkString retval); const wchar_t *CkAuthGoogleW_version(HCkAuthGoogleW cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AccessToken` | property, read/write | `void CkAuthGoogleW_getAccessToken(HCkAuthGoogleW cHandle, HCkString retval); void CkAuthGoogleW_putAccessToken(HCkAuthGoogleW cHandle, const wchar_t *newVal); const wchar_t *CkAuthGoogleW_accessToken(HCkAuthGoogleW cHandle);` |
| `EmailAddress` | property, read/write | `void CkAuthGoogleW_getEmailAddress(HCkAuthGoogleW cHandle, HCkString retval); void CkAuthGoogleW_putEmailAddress(HCkAuthGoogleW cHandle, const wchar_t *newVal); const wchar_t *CkAuthGoogleW_emailAddress(HCkAuthGoogleW cHandle);` |
| `ExpireNumSeconds` | property, read/write | `int CkAuthGoogleW_getExpireNumSeconds(HCkAuthGoogleW cHandle); void CkAuthGoogleW_putExpireNumSeconds(HCkAuthGoogleW cHandle, int newVal);` |
| `Iat` | property, read/write | `int CkAuthGoogleW_getIat(HCkAuthGoogleW cHandle); void CkAuthGoogleW_putIat(HCkAuthGoogleW cHandle, int newVal);` |
| `JsonKey` | property, read/write | `void CkAuthGoogleW_getJsonKey(HCkAuthGoogleW cHandle, HCkString retval); void CkAuthGoogleW_putJsonKey(HCkAuthGoogleW cHandle, const wchar_t *newVal); const wchar_t *CkAuthGoogleW_jsonKey(HCkAuthGoogleW cHandle);` |
| `NumSecondsRemaining` | property, read-only | `int CkAuthGoogleW_getNumSecondsRemaining(HCkAuthGoogleW cHandle);` |
| `Scope` | property, read/write | `void CkAuthGoogleW_getScope(HCkAuthGoogleW cHandle, HCkString retval); void CkAuthGoogleW_putScope(HCkAuthGoogleW cHandle, const wchar_t *newVal); const wchar_t *CkAuthGoogleW_scope(HCkAuthGoogleW cHandle);` |
| `SubEmailAddress` | property, read/write | `void CkAuthGoogleW_getSubEmailAddress(HCkAuthGoogleW cHandle, HCkString retval); void CkAuthGoogleW_putSubEmailAddress(HCkAuthGoogleW cHandle, const wchar_t *newVal); const wchar_t *CkAuthGoogleW_subEmailAddress(HCkAuthGoogleW cHandle);` |
| `Valid` | property, read-only | `BOOL CkAuthGoogleW_getValid(HCkAuthGoogleW cHandle);` |
| `AddClaims` | method | `BOOL CkAuthGoogleW_AddClaims(HCkAuthGoogleW cHandle, HCkJsonObjectW json);` |
| `GetP12` | method | `HCkPfxW CkAuthGoogleW_GetP12(HCkAuthGoogleW cHandle);` |
| `LoadTaskCaller` | method | `BOOL CkAuthGoogleW_LoadTaskCaller(HCkAuthGoogleW cHandle, HCkTaskW task);` |
| `ObtainAccessToken` | method | `BOOL CkAuthGoogleW_ObtainAccessToken(HCkAuthGoogleW cHandle, HCkSocketW connection);` |
| `SetP12` | method | `BOOL CkAuthGoogleW_SetP12(HCkAuthGoogleW cHandle, HCkPfxW key);` |

## Properties

### AuthGoogle.AccessToken

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

```c
void CkAuthGoogleW_getAccessToken(HCkAuthGoogleW cHandle, HCkString retval);
void CkAuthGoogleW_putAccessToken(HCkAuthGoogleW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthGoogleW_accessToken(HCkAuthGoogleW cHandle);
```

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 · wc · AuthGoogle · EmailAddress · property · read/write · since 9.5.0.58`

```c
void CkAuthGoogleW_getEmailAddress(HCkAuthGoogleW cHandle, HCkString retval);
void CkAuthGoogleW_putEmailAddress(HCkAuthGoogleW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthGoogleW_emailAddress(HCkAuthGoogleW cHandle);
```

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 · wc · AuthGoogle · ExpireNumSeconds · property · read/write · since 9.5.0.58`

```c
int CkAuthGoogleW_getExpireNumSeconds(HCkAuthGoogleW cHandle);
void CkAuthGoogleW_putExpireNumSeconds(HCkAuthGoogleW cHandle, int newVal);
```

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 · wc · AuthGoogle · Iat · property · read/write · since 9.5.0.77`

```c
int CkAuthGoogleW_getIat(HCkAuthGoogleW cHandle);
void CkAuthGoogleW_putIat(HCkAuthGoogleW cHandle, int newVal);
```

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 · wc · AuthGoogle · JsonKey · property · read/write · since 9.5.0.58`

```c
void CkAuthGoogleW_getJsonKey(HCkAuthGoogleW cHandle, HCkString retval);
void CkAuthGoogleW_putJsonKey(HCkAuthGoogleW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthGoogleW_jsonKey(HCkAuthGoogleW cHandle);
```

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 · wc · AuthGoogle · NumSecondsRemaining · property · read-only · since 9.5.0.58`

```c
int CkAuthGoogleW_getNumSecondsRemaining(HCkAuthGoogleW cHandle);
```

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 · wc · AuthGoogle · Scope · property · read/write · since 9.5.0.58`

```c
void CkAuthGoogleW_getScope(HCkAuthGoogleW cHandle, HCkString retval);
void CkAuthGoogleW_putScope(HCkAuthGoogleW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthGoogleW_scope(HCkAuthGoogleW cHandle);
```

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

### AuthGoogle.SubEmailAddress

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

```c
void CkAuthGoogleW_getSubEmailAddress(HCkAuthGoogleW cHandle, HCkString retval);
void CkAuthGoogleW_putSubEmailAddress(HCkAuthGoogleW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthGoogleW_subEmailAddress(HCkAuthGoogleW cHandle);
```

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

### AuthGoogle.Valid

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

```c
BOOL CkAuthGoogleW_getValid(HCkAuthGoogleW cHandle);
```

`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 · wc · AuthGoogle · AddClaims · method · since 9.5.0.99`

```c
BOOL CkAuthGoogleW_AddClaims(HCkAuthGoogleW cHandle, HCkJsonObjectW json);
```

Adds additional custom claims to the JWT claims set.

Returns TRUE for success, FALSE for failure.

### AuthGoogle.GetP12

`Chilkat 11.7.0 · wc · AuthGoogle · GetP12 · method · since 9.5.0.58`

```c
HCkPfxW CkAuthGoogleW_GetP12(HCkAuthGoogleW cHandle);
```

Returns the private key in a PFX (P12) object. This is only possible if the private key was previously set by calling SetP12.

Returns `NULL` on failure

### AuthGoogle.LoadTaskCaller

`Chilkat 11.7.0 · wc · AuthGoogle · LoadTaskCaller · method · since 9.5.0.80`

```c
BOOL CkAuthGoogleW_LoadTaskCaller(HCkAuthGoogleW cHandle, HCkTaskW task);
```

Loads the caller of the task's async method.

Returns TRUE for success, FALSE for failure.

### AuthGoogle.ObtainAccessToken

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

```c
BOOL CkAuthGoogleW_ObtainAccessToken(HCkAuthGoogleW cHandle, HCkSocketW connection);
```

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.

Async variant: `ObtainAccessTokenAsync` — same arguments, returns a `Task` (see Async variants below).

### AuthGoogle.SetP12

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

```c
BOOL CkAuthGoogleW_SetP12(HCkAuthGoogleW cHandle, HCkPfxW key);
```

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 delivers progress information through callbacks (AbortCheck, PercentDone, ProgressInfo, TaskCompleted) rather than events. See `guide.md` for how to attach them in Unicode C.

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```c
HCkTaskW CkAuthGoogleW_ObtainAccessTokenAsync(HCkAuthGoogleW cHandle, HCkSocketW connection);
```

## Related classes

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

