---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: AuthGoogle
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_AuthGoogleRef.html
---
# Chilkat AuthGoogle — SQL Server — v11.7.0

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

```sql
DECLARE @hr int
DECLARE @authGoogle int
EXEC @hr = sp_OACreate 'Chilkat.AuthGoogle', @authGoogle OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @authGoogle ...

EXEC @hr = sp_OADestroy @authGoogle
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.AuthGoogle.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @authGoogle, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

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 SQL Server.

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` | `EXEC sp_OAGetProperty @authGoogle, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @authGoogle, 'DebugLogFilePath', @sValue` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `INSERT INTO @tmp EXEC sp_OAGetProperty @authGoogle, 'LastBinaryResult'` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `EXEC sp_OAGetProperty @authGoogle, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @authGoogle, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @authGoogle, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @authGoogle, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @authGoogle, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @authGoogle, 'LastStringResult', @sValue OUT` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `EXEC sp_OAGetProperty @authGoogle, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @authGoogle, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @authGoogle, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @authGoogle, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AccessToken` | property, read/write | `EXEC sp_OAGetProperty @authGoogle, 'AccessToken', @sValue OUT EXEC sp_OASetProperty @authGoogle, 'AccessToken', @sValue` |
| `EmailAddress` | property, read/write | `EXEC sp_OAGetProperty @authGoogle, 'EmailAddress', @sValue OUT EXEC sp_OASetProperty @authGoogle, 'EmailAddress', @sValue` |
| `ExpireNumSeconds` | property, read/write | `EXEC sp_OAGetProperty @authGoogle, 'ExpireNumSeconds', @iValue OUT EXEC sp_OASetProperty @authGoogle, 'ExpireNumSeconds', @iValue` |
| `Iat` | property, read/write | `EXEC sp_OAGetProperty @authGoogle, 'Iat', @iValue OUT EXEC sp_OASetProperty @authGoogle, 'Iat', @iValue` |
| `JsonKey` | property, read/write | `EXEC sp_OAGetProperty @authGoogle, 'JsonKey', @sValue OUT EXEC sp_OASetProperty @authGoogle, 'JsonKey', @sValue` |
| `NumSecondsRemaining` | property, read-only | `EXEC sp_OAGetProperty @authGoogle, 'NumSecondsRemaining', @iValue OUT` |
| `Scope` | property, read/write | `EXEC sp_OAGetProperty @authGoogle, 'Scope', @sValue OUT EXEC sp_OASetProperty @authGoogle, 'Scope', @sValue` |
| `SubEmailAddress` | property, read/write | `EXEC sp_OAGetProperty @authGoogle, 'SubEmailAddress', @sValue OUT EXEC sp_OASetProperty @authGoogle, 'SubEmailAddress', @sValue` |
| `Valid` | property, read-only | `EXEC sp_OAGetProperty @authGoogle, 'Valid', @iValue OUT` |
| `AddClaims` | method | `EXEC sp_OAMethod @authGoogle, 'AddClaims', @success OUT, @json` |
| `GetP12` | method | `EXEC sp_OAMethod @authGoogle, 'GetP12', @pfx OUT -- returns a ChilkatPfx object token` |
| `ObtainAccessToken` | method | `EXEC sp_OAMethod @authGoogle, 'ObtainAccessToken', @success OUT, @connection` |
| `SetP12` | method | `EXEC sp_OAMethod @authGoogle, 'SetP12', @success OUT, @key` |

## Properties

### AuthGoogle.AccessToken

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

```sql
EXEC sp_OAGetProperty @authGoogle, 'AccessToken', @sValue OUT
EXEC sp_OASetProperty @authGoogle, 'AccessToken', @sValue
```

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

```sql
EXEC sp_OAGetProperty @authGoogle, 'EmailAddress', @sValue OUT
EXEC sp_OASetProperty @authGoogle, 'EmailAddress', @sValue
```

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

```sql
EXEC sp_OAGetProperty @authGoogle, 'ExpireNumSeconds', @iValue OUT
EXEC sp_OASetProperty @authGoogle, 'ExpireNumSeconds', @iValue
```

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

```sql
EXEC sp_OAGetProperty @authGoogle, 'Iat', @iValue OUT
EXEC sp_OASetProperty @authGoogle, 'Iat', @iValue
```

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

```sql
EXEC sp_OAGetProperty @authGoogle, 'JsonKey', @sValue OUT
EXEC sp_OASetProperty @authGoogle, 'JsonKey', @sValue
```

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

```sql
EXEC sp_OAGetProperty @authGoogle, 'NumSecondsRemaining', @iValue OUT
```

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

```sql
EXEC sp_OAGetProperty @authGoogle, 'Scope', @sValue OUT
EXEC sp_OASetProperty @authGoogle, 'Scope', @sValue
```

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

### AuthGoogle.SubEmailAddress

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

```sql
EXEC sp_OAGetProperty @authGoogle, 'SubEmailAddress', @sValue OUT
EXEC sp_OASetProperty @authGoogle, 'SubEmailAddress', @sValue
```

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

### AuthGoogle.Valid

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

```sql
EXEC sp_OAGetProperty @authGoogle, 'Valid', @iValue OUT
```

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

## Methods

### AuthGoogle.AddClaims

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

```sql
EXEC sp_OAMethod @authGoogle, 'AddClaims', @success OUT, @json
```

Adds additional custom claims to the JWT claims set.

Returns 1 for success, 0 for failure.

### AuthGoogle.GetP12

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

```sql
EXEC sp_OAMethod @authGoogle, 'GetP12', @pfx OUT  -- returns a ChilkatPfx object token
```

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.ObtainAccessToken

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

```sql
EXEC sp_OAMethod @authGoogle, 'ObtainAccessToken', @success OUT, @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 1 for success, 0 for failure.

### AuthGoogle.SetP12

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

```sql
EXEC sp_OAMethod @authGoogle, 'SetP12', @success OUT, @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 1 for success, 0 for failure.

## Events and callbacks

This binding has no event callbacks.

## Related classes

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

