--- product: Chilkat product_version: 11.7.0 language: pascal language_label: Lazarus Pascal class: AuthGoogle license: bundle deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/pascal_AuthGoogleRef.html --- # Chilkat AuthGoogle — Lazarus Pascal — v11.7.0 > Chilkat 11.7.0 · language=pascal · class=AuthGoogle > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/AuthGoogle.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/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 / Free** ```pascal uses Chilkat.AuthGoogle; var obj: TAuthGoogle; begin obj := TAuthGoogle.Create; try if not obj.IsValid then raise Exception.Create('Failed to create a TAuthGoogle instance.'); // ... use obj ... finally obj.Free; end; end; ``` `constructor Create;` Allocates the underlying CkAuthGoogle object and returns a new TAuthGoogle instance. Simply adding **Chilkat.AuthGoogle** to the unit's `uses` clause is enough to locate and bind to the Chilkat shared library (DLL / .so / .dylib) at runtime — no separate load step is required. Check `obj.IsValid` after calling `Create`; it is `False` if the underlying library could not be found/loaded or the object could not be allocated (for example, when unlicensed). `destructor Destroy; override;` Every TAuthGoogle created by calling `Create` should eventually be released by calling `.Free` (inherited from `TObject`). The destructor automatically disposes the underlying CkAuthGoogle handle. A native (unmanaged) memory leak occurs if the object is never freed. 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 Lazarus Pascal. ## 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` | `property DebugLogFilePath: string read GetDebugLogFilePath write SetDebugLogFilePath;` | 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` | `property LastErrorHtml: string read GetLastErrorHtml;` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `property LastErrorText: string read GetLastErrorText;` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `property LastErrorXml: string read GetLastErrorXml;` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `property LastMethodSuccess: Boolean read GetLastMethodSuccess write SetLastMethodSuccess;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. | | `VerboseLogging` | `property VerboseLogging: Boolean read GetVerboseLogging write SetVerboseLogging;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `property Version: string read GetVersion;` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `AccessToken` | property, read/write | `property AccessToken: string read GetAccessToken write SetAccessToken;` | | `EmailAddress` | property, read/write | `property EmailAddress: string read GetEmailAddress write SetEmailAddress;` | | `ExpireNumSeconds` | property, read/write | `property ExpireNumSeconds: Integer read GetExpireNumSeconds write SetExpireNumSeconds;` | | `Iat` | property, read/write | `property Iat: Integer read GetIat write SetIat;` | | `JsonKey` | property, read/write | `property JsonKey: string read GetJsonKey write SetJsonKey;` | | `NumSecondsRemaining` | property, read-only | `property NumSecondsRemaining: Integer read GetNumSecondsRemaining;` | | `Scope` | property, read/write | `property Scope: string read GetScope write SetScope;` | | `SubEmailAddress` | property, read/write | `property SubEmailAddress: string read GetSubEmailAddress write SetSubEmailAddress;` | | `Valid` | property, read-only | `property Valid: Boolean read GetValid;` | | `AddClaims` | method | `// json is a TJsonObject object. function AddClaims(json: TChilkatBase): Boolean;` | | `GetP12` | method | `// Return value is a TPfx object. function GetP12: TChilkatBase;` | | `LoadTaskCaller` | method | `// task is a TTask object. function LoadTaskCaller(task: TChilkatBase): Boolean;` | | `ObtainAccessToken` | method | `// connection is a TSocket object. function ObtainAccessToken(connection: TChilkatBase): Boolean;` | | `SetP12` | method | `// key is a TPfx object. function SetP12(key: TChilkatBase): Boolean;` | ## Properties ### AuthGoogle.AccessToken `Chilkat 11.7.0 · pascal · AuthGoogle · AccessToken · property · read/write · since 9.5.0.58` ```pascal property AccessToken: string read GetAccessToken write SetAccessToken; ``` 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 · pascal · AuthGoogle · EmailAddress · property · read/write · since 9.5.0.58` ```pascal property EmailAddress: string read GetEmailAddress write SetEmailAddress; ``` 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 · pascal · AuthGoogle · ExpireNumSeconds · property · read/write · since 9.5.0.58` ```pascal property ExpireNumSeconds: Integer read GetExpireNumSeconds write SetExpireNumSeconds; ``` 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 · pascal · AuthGoogle · Iat · property · read/write · since 9.5.0.77` ```pascal property Iat: Integer read GetIat write SetIat; ``` 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 · pascal · AuthGoogle · JsonKey · property · read/write · since 9.5.0.58` ```pascal property JsonKey: string read GetJsonKey write SetJsonKey; ``` 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 · pascal · AuthGoogle · NumSecondsRemaining · property · read-only · since 9.5.0.58` ```pascal property NumSecondsRemaining: Integer read GetNumSecondsRemaining; ``` 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 · pascal · AuthGoogle · Scope · property · read/write · since 9.5.0.58` ```pascal property Scope: string read GetScope write SetScope; ``` A space-delimited list of the permissions that the application requests. ### AuthGoogle.SubEmailAddress `Chilkat 11.7.0 · pascal · AuthGoogle · SubEmailAddress · property · read/write · since 9.5.0.58` ```pascal property SubEmailAddress: string read GetSubEmailAddress write SetSubEmailAddress; ``` The email address of the user for which the application is requesting delegated access. ### AuthGoogle.Valid `Chilkat 11.7.0 · pascal · AuthGoogle · Valid · property · read-only · since 9.5.0.58` ```pascal property Valid: Boolean read GetValid; ``` `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 · pascal · AuthGoogle · AddClaims · method · since 9.5.0.99` ```pascal // json is a TJsonObject object. function AddClaims(json: TChilkatBase): Boolean; ``` Adds additional custom claims to the JWT claims set. Returns True for success, False for failure. ### AuthGoogle.GetP12 `Chilkat 11.7.0 · pascal · AuthGoogle · GetP12 · method · since 9.5.0.58` ```pascal // Return value is a TPfx object. function GetP12: TChilkatBase; ``` Returns the private key in a PFX (P12) object. This is only possible if the private key was previously set by calling SetP12. Returns `nil` on failure ### AuthGoogle.LoadTaskCaller `Chilkat 11.7.0 · pascal · AuthGoogle · LoadTaskCaller · method · since 9.5.0.80` ```pascal // task is a TTask object. function LoadTaskCaller(task: TChilkatBase): Boolean; ``` Loads the caller of the task's async method. Returns True for success, False for failure. ### AuthGoogle.ObtainAccessToken `Chilkat 11.7.0 · pascal · AuthGoogle · ObtainAccessToken · method · since 9.5.0.58` ```pascal // connection is a TSocket object. function ObtainAccessToken(connection: TChilkatBase): Boolean; ``` 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 · pascal · AuthGoogle · SetP12 · method · since 9.5.0.58` ```pascal // key is a TPfx object. function SetP12(key: TChilkatBase): Boolean; ``` 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 Chilkat for Pascal supports three synchronous event callbacks: `OnAbortCheck`, `OnPercentDone`, and `OnProgressInfo`. Each is a property of the class; assign a method of one of your own objects (an *of object* handler) to receive the callbacks, or assign `nil` to unhook. The handler types are declared in the `Chilkat.Base` unit: ```pascal TChilkatAbortCheckEvent = function(Sender: TChilkatBase): Boolean of object; TChilkatPercentDoneEvent = function(Sender: TChilkatBase; PctDone: Integer): Boolean of object; TChilkatProgressInfoEvent = procedure(Sender: TChilkatBase; const Name, Value: string) of object; ``` All Chilkat methods are synchronous, so callbacks are invoked on the thread that called the method -- if the method was called from the main thread, it is safe to access UI elements from the handler. The `HeartbeatMs` property controls the frequency of `OnAbortCheck` callbacks (the default of 0 means no AbortCheck events fire). Returning `True` from an `OnAbortCheck` or `OnPercentDone` handler aborts the running method. ### AuthGoogle.AbortCheck (event) `Chilkat 11.7.0 · pascal · AuthGoogle · AbortCheck · event` ```pascal // TChilkatAbortCheckEvent = function(Sender: TChilkatBase): Boolean of object; property OnAbortCheck: TChilkatAbortCheckEvent; ``` Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the `HeartbeatMs` property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second. **Event callback implementation:** ```pascal // A handler is a method of one of your own classes, e.g. a form: function TMyObject.AuthGoogleAbortCheck(Sender: TChilkatBase): Boolean; begin // Called every HeartbeatMs milliseconds while a method is running. // Return True to abort the method; return False to continue. Result := False; end; ``` **To add an event handler:** ```pascal authgoogle := TAuthGoogle.Create; authgoogle.HeartbeatMs := 250; // fire OnAbortCheck 4 times per second authgoogle.OnAbortCheck := MyObject.AuthGoogleAbortCheck; ``` ### AuthGoogle.PercentDone (event) `Chilkat 11.7.0 · pascal · AuthGoogle · PercentDone · event` ```pascal // TChilkatPercentDoneEvent = function(Sender: TChilkatBase; PctDone: Integer): Boolean of object; property OnPercentDone: TChilkatPercentDoneEvent; ``` This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The `pctDone` argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have `pctDone` equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100). The PercentDone callback also acts as an `AbortCheck` event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination. To abort the operation, set the `abort` output argument to `True`. This will cause the method to terminate and return a failure status or corresponding failure value. **Event callback implementation:** ```pascal // A handler is a method of one of your own classes, e.g. a form: function TMyObject.AuthGooglePercentDone(Sender: TChilkatBase; PctDone: Integer): Boolean; begin // PctDone ranges from 1 to 100. WriteLn('Percent done: ', PctDone); // Return True to abort the method; return False to continue. Result := False; end; ``` **To add an event handler:** ```pascal authgoogle := TAuthGoogle.Create; authgoogle.OnPercentDone := MyObject.AuthGooglePercentDone; ``` ### AuthGoogle.ProgressInfo (event) `Chilkat 11.7.0 · pascal · AuthGoogle · ProgressInfo · event` ```pascal // TChilkatProgressInfoEvent = procedure(Sender: TChilkatBase; const Name, Value: string) of object; property OnProgressInfo: TChilkatProgressInfoEvent; ``` This event callback provides `tag name`/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory. Note: Some Chilkat methods don't fire any ProgressInfo events. **Event callback implementation:** ```pascal // A handler is a method of one of your own classes, e.g. a form: procedure TMyObject.AuthGoogleProgressInfo(Sender: TChilkatBase; const Name, Value: string); begin WriteLn(Name, ': ', Value); end; ``` **To add an event handler:** ```pascal authgoogle := TAuthGoogle.Create; authgoogle.OnProgressInfo := MyObject.AuthGoogleProgressInfo; ``` ## Related classes [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/JsonObject.md), [`Pfx`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/Pfx.md), [`Socket`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/Socket.md)