AuthGoogle Ruby Reference Documentation

CkAuthGoogle

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 = Chilkat::CkAuthGoogle.new()

Properties

AccessToken
# strVal is a string
# ckStr is a CkString
authGoogle.get_AccessToken(ckStr);
strVal = authGoogle.accessToken();
authGoogle.put_AccessToken(strVal);
Introduced in version 9.5.0.58

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.

top
DebugLogFilePath
# strVal is a string
# ckStr is a CkString
authGoogle.get_DebugLogFilePath(ckStr);
strVal = authGoogle.debugLogFilePath();
authGoogle.put_DebugLogFilePath(strVal);

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.

More Information and Examples
top
EmailAddress
# strVal is a string
# ckStr is a CkString
authGoogle.get_EmailAddress(ckStr);
strVal = authGoogle.emailAddress();
authGoogle.put_EmailAddress(strVal);
Introduced in version 9.5.0.58

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.

top
ExpireNumSeconds
# intVal is an integer
intVal = authGoogle.get_ExpireNumSeconds();
authGoogle.put_ExpireNumSeconds(intVal);
Introduced in version 9.5.0.58

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.

top
Iat
# intVal is an integer
intVal = authGoogle.get_Iat();
authGoogle.put_Iat(intVal);
Introduced in version 9.5.0.77

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.

top
JsonKey
# strVal is a string
# ckStr is a CkString
authGoogle.get_JsonKey(ckStr);
strVal = authGoogle.jsonKey();
authGoogle.put_JsonKey(strVal);
Introduced in version 9.5.0.58

The JSON key for obtaining an access token. An application must set either the P12 or JSON private key, but not both.

top
LastErrorHtml
# strVal is a string
# ckStr is a CkString
authGoogle.get_LastErrorHtml(ckStr);
strVal = authGoogle.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.

top
LastErrorText
# strVal is a string
# ckStr is a CkString
authGoogle.get_LastErrorText(ckStr);
strVal = authGoogle.lastErrorText();

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.

top
LastErrorXml
# strVal is a string
# ckStr is a CkString
authGoogle.get_LastErrorXml(ckStr);
strVal = authGoogle.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.

top
LastMethodSuccess
# boolVal is a boolean
boolVal = authGoogle.get_LastMethodSuccess();
authGoogle.put_LastMethodSuccess(boolVal);

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.

top
NumSecondsRemaining
# intVal is an integer
intVal = authGoogle.get_NumSecondsRemaining();
Introduced in version 9.5.0.58

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.

top
Scope
# strVal is a string
# ckStr is a CkString
authGoogle.get_Scope(ckStr);
strVal = authGoogle.scope();
authGoogle.put_Scope(strVal);
Introduced in version 9.5.0.58

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

top
SubEmailAddress
# strVal is a string
# ckStr is a CkString
authGoogle.get_SubEmailAddress(ckStr);
strVal = authGoogle.subEmailAddress();
authGoogle.put_SubEmailAddress(strVal);
Introduced in version 9.5.0.58

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

top
Utf8
# boolVal is a boolean
boolVal = authGoogle.get_Utf8();
authGoogle.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

top
Valid
# boolVal is a boolean
boolVal = authGoogle.get_Valid();
Introduced in version 9.5.0.58

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

top
VerboseLogging
# boolVal is a boolean
boolVal = authGoogle.get_VerboseLogging();
authGoogle.put_VerboseLogging(boolVal);

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.

top
Version
# strVal is a string
# ckStr is a CkString
authGoogle.get_Version(ckStr);
strVal = authGoogle.version();

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

AddClaims
# json is a CkJsonObject
status = authGoogle.AddClaims(json);
Introduced in version 9.5.0.99

Adds additional custom claims to the JWT claims set.

Returns true for success, false for failure.

top
GetP12
# returns a CkPfx
ret_pfx = authGoogle.GetP12();
Introduced in version 9.5.0.58

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

top
LoadTaskCaller
# task is a CkTask
status = authGoogle.LoadTaskCaller(task);
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

top
ObtainAccessToken
# connection is a CkSocket
status = authGoogle.ObtainAccessToken(connection);
Introduced in version 9.5.0.58

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.

top
ObtainAccessTokenAsync (1)
# returns a CkTask
# connection is a CkSocket
ret_task = authGoogle.ObtainAccessTokenAsync(connection);
Introduced in version 9.5.0.58

Creates an asynchronous task to call the ObtainAccessToken method with the arguments provided.

Returns nil on failure

top
SetP12
# key is a CkPfx
status = authGoogle.SetP12(key);
Introduced in version 9.5.0.58

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.

top