AuthGoogle PureBasic Reference Documentation
AuthGoogle
Current Version: 10.1.2
Provides functionality for authenticating calls to the Google Cloud Platform API and Google Apps API using a service account.
Object Creation
obj.i = CkAuthGoogle::ckCreate()
; Make sure to dispose of the object when finished like this:
CkAuthGoogle::ckDispose(obj);
Properties
AccessToken
Declare setCkAccessToken(obj.i, value.s)
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
Declare setCkDebugLogFilePath(obj.i, value.s)
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
Declare setCkEmailAddress(obj.i, value.s)
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
Declare setCkExpireNumSeconds(obj.i, value.i)
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
Declare setCkIat(obj.i, value.i)
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
Declare setCkJsonKey(obj.i, value.s)
The JSON key for obtaining an access token. An application must set either the P12 or JSON private key, but not both.
LastErrorHtml
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
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
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
Declare setCkLastMethodSuccess(obj.i, value.i)
Indicates the success or failure of the most recent method call: 1 means success, 0 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.
topNumSecondsRemaining
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
Declare setCkScope(obj.i, value.s)
A space-delimited list of the permissions that the application requests.
topSubEmailAddress
Declare setCkSubEmailAddress(obj.i, value.s)
The email address of the user for which the application is requesting delegated access.
topValid
1 if the AccessToken property contains a valid non-expired access token obtained via the call to ObtainAccessToken.
topVerboseLogging
Declare setCkVerboseLogging(obj.i, value.i)
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
Methods
AddClaims
Adds additional custom claims to the JWT claims set.
Returns 1 for success, 0 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 0 on failure
topLoadTaskCaller
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 1 for success, 0 for failure.
ObtainAccessTokenAsync (1)
Creates an asynchronous task to call the ObtainAccessToken method with the arguments provided.
Returns 0 on failure
topSetP12
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.