AuthGoogle Unicode C Reference Documentation
AuthGoogle
Current Version: 11.6.0
Chilkat.AuthGoogle
Authenticate server-to-server using a Google service account rather than
an interactive browser-based user consent flow.
Load service account credentials from modern JSON private keys or from
legacy P12 private key files.
Specify the OAuth scopes required by the target Google API and add custom
JWT claims when needed.
Use domain-wide delegation by setting a subject email when the service
account is authorized to act on behalf of a Google Workspace user.
Inspect the generated access token, expiration time, remaining lifetime,
and validity state before using or refreshing credentials.
Pass the resulting bearer token to Chilkat HTTP, REST, storage, mail, or
other Google API request workflows.
For an extended overview, see
AuthGoogle Class Overview.
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
JSON or P12 keys
Scopes and claims
Delegated user access
Access-token tracking
Chilkat API integration
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.
Create/Dispose
HCkAuthGoogleW instance = CkAuthGoogleW_Create();
// ...
CkAuthGoogleW_Dispose(instance);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.
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.
Callback Functions
void CkAuthGoogleW_setAbortCheck(HCkHttp cHandle, BOOL (*fnAbortCheck)(void));
Gives your application a chance to cancel a method call while it is running. Return TRUEFALSE
This callback fires periodically, at the interval set by the HeartbeatMs property. For example, set HeartbeatMs to 200 to receive five AbortCheck callbacks per second. If HeartbeatMs is 0, no callbacks are made and the operation cannot be aborted.
void CkAuthGoogleW_setPercentDone(HCkHttp cHandle, BOOL (*fnPercentDone)(int pctDone));
Reports how far along a method call is, as a percentage. It applies to methods that involve network communication or time-consuming processing, and fires only when a percentage completed can actually be measured and it makes sense to express progress that way.
The pctDone argument is a value from 1 to 100. Methods that finish very quickly may produce only a few callbacks, but the final callback always reports 100. Long-running operations produce at most one callback per percentage point (for example: 1, 2, 3, … 98, 99, 100).
This callback also counts as an AbortCheck callback. When PercentDone fires, it replaces the AbortCheck callback that would otherwise have occurred at that moment.
The return value controls whether the method call continues. Return TRUEFALSE
void CkAuthGoogleW_setProgressInfo(HCkHttp cHandle, void (*fnProgressInfo)(const wchar_t *name, const wchar_t *value));
A general-purpose callback that reports name/value pairs describing what is happening at various points during a method call. The information provided varies by method, and some methods provide none at all. To see what a particular method reports, write a handler that logs each name/value pair. Most are self-explanatory.
void CkAuthGoogleW_setTaskCompleted(HCkHttp cHandle, void (*fnTaskCompleted)(HCkTask hTask));
Called when an asynchronous task finishes. This callback runs in the background thread rather than the thread that started the task. (While an async method is running, all callbacks occur in the background thread.)
Properties
AccessToken
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.
topDebugLogFilePath
void CkAuthGoogleW_putDebugLogFilePath(HCkAuthGoogleW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthGoogleW_debugLogFilePath(HCkAuthGoogleW cHandle);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
EmailAddress
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.
ExpireNumSeconds
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.
topIat
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.
topJsonKey
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.
LastErrorHtml
const wchar_t *CkAuthGoogleW_lastErrorHtml(HCkAuthGoogleW cHandle);
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
const wchar_t *CkAuthGoogleW_lastErrorText(HCkAuthGoogleW cHandle);
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
const wchar_t *CkAuthGoogleW_lastErrorXml(HCkAuthGoogleW cHandle);
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
void CkAuthGoogleW_putLastMethodSuccess(HCkAuthGoogleW cHandle, BOOL newVal);
Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
NumSecondsRemaining
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.
topScope
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.
topSubEmailAddress
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.
topValid
TRUE if the AccessToken property contains a valid non-expired access token obtained via the call to ObtainAccessToken.
VerboseLogging
void CkAuthGoogleW_putVerboseLogging(HCkAuthGoogleW cHandle, BOOL newVal);
If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
const wchar_t *CkAuthGoogleW_version(HCkAuthGoogleW cHandle);
Methods
AddClaims
Adds additional custom claims to the JWT claims set.
Returns TRUE for success, FALSE for failure.
GetP12
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
LoadTaskCaller
ObtainAccessToken
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.
ObtainAccessTokenAsync (1)
Creates an asynchronous task to call the ObtainAccessToken method with the arguments provided.
Returns NULL on failure
SetP12
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.