AuthAzureAD C Reference Documentation

AuthAzureAD

Current Version: 9.5.0.75

Provides functionality for obtaining an Azure AD access token via OAuth2 for Service to Service Calls Using Client Credentials. (See https://msdn.microsoft.com/en-us/library/dn645543.aspx)

Create/Dispose

HCkAuthAzureAD instance = CkAuthAzureAD_Create();
// ...
CkAuthAzureAD_Dispose(instance);
HCkAuthAzureAD CkAuthAzureAD_Create(void);

Creates an instance of the HCkAuthAzureAD object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkAuthAzureAD_Dispose(HCkAuthAzureAD handle);

Objects created by calling CkAuthAzureAD_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 CkAuthAzureAD_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkAuthAzureAD_setAbortCheck(HCkAuthAzureAD cHandle, BOOL (*fnAbortCheck)(void));

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

void CkAuthAzureAD_setPercentDone(HCkAuthAzureAD cHandle, BOOL (*fnPercentDone)(int pctDone));

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This callback is only called when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For methods that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkAuthAzureAD_setProgressInfo(HCkAuthAzureAD cHandle, void (*fnProgressInfo)(const char *name, const char *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkAuthAzureAD_setTaskCompleted(HCkAuthAzureAD cHandle, void (*fnTaskCompleted)(HCkTask hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)

Properties

AccessToken
void CkAuthAzureAD_getAccessToken(HCkAuthAzureAD cHandle, HCkString retval);
void CkAuthAzureAD_putAccessToken(HCkAuthAzureAD cHandle, const char *newVal);
const char *CkAuthAzureAD_accessToken(HCkAuthAzureAD cHandle);
Introduced in version 9.5.0.58

The access token to be used in Azure AD REST API requests. This property is set on a successful call to ObtainAccessToken.

More Information and Examples
top
ClientId
void CkAuthAzureAD_getClientId(HCkAuthAzureAD cHandle, HCkString retval);
void CkAuthAzureAD_putClientId(HCkAuthAzureAD cHandle, const char *newVal);
const char *CkAuthAzureAD_clientId(HCkAuthAzureAD cHandle);
Introduced in version 9.5.0.58

Specifies the Azure AD client id of the calling web service. To find the calling application's client ID, in the Azure Management Portal, click Active Directory, click the directory, click the application, and then click Configure.

top
ClientSecret
void CkAuthAzureAD_getClientSecret(HCkAuthAzureAD cHandle, HCkString retval);
void CkAuthAzureAD_putClientSecret(HCkAuthAzureAD cHandle, const char *newVal);
const char *CkAuthAzureAD_clientSecret(HCkAuthAzureAD cHandle);
Introduced in version 9.5.0.58

A key registered for the calling web service in Azure AD. To create a key, in the Azure Management Portal, click Active Directory, click the directory, click the application, and then click Configure.

top
DebugLogFilePath
void CkAuthAzureAD_getDebugLogFilePath(HCkAuthAzureAD cHandle, HCkString retval);
void CkAuthAzureAD_putDebugLogFilePath(HCkAuthAzureAD cHandle, const char *newVal);
const char *CkAuthAzureAD_debugLogFilePath(HCkAuthAzureAD cHandle);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
void CkAuthAzureAD_getLastErrorHtml(HCkAuthAzureAD cHandle, HCkString retval);
const char *CkAuthAzureAD_lastErrorHtml(HCkAuthAzureAD cHandle);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
void CkAuthAzureAD_getLastErrorText(HCkAuthAzureAD cHandle, HCkString retval);
const char *CkAuthAzureAD_lastErrorText(HCkAuthAzureAD cHandle);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
void CkAuthAzureAD_getLastErrorXml(HCkAuthAzureAD cHandle, HCkString retval);
const char *CkAuthAzureAD_lastErrorXml(HCkAuthAzureAD cHandle);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
BOOL CkAuthAzureAD_getLastMethodSuccess(HCkAuthAzureAD cHandle);
void CkAuthAzureAD_putLastMethodSuccess(HCkAuthAzureAD cHandle, BOOL newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumSecondsRemaining
int CkAuthAzureAD_getNumSecondsRemaining(HCkAuthAzureAD cHandle);
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
Resource
void CkAuthAzureAD_getResource(HCkAuthAzureAD cHandle, HCkString retval);
void CkAuthAzureAD_putResource(HCkAuthAzureAD cHandle, const char *newVal);
const char *CkAuthAzureAD_resource(HCkAuthAzureAD cHandle);
Introduced in version 9.5.0.58

The App ID URI of the receiving web service. To find the App ID URI, in the Azure Management Portal, click Active Directory, click the directory, click the application, and then click Configure.

top
TenantId
void CkAuthAzureAD_getTenantId(HCkAuthAzureAD cHandle, HCkString retval);
void CkAuthAzureAD_putTenantId(HCkAuthAzureAD cHandle, const char *newVal);
const char *CkAuthAzureAD_tenantId(HCkAuthAzureAD cHandle);
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
Utf8
BOOL CkAuthAzureAD_getUtf8(HCkAuthAzureAD cHandle);
void CkAuthAzureAD_putUtf8(HCkAuthAzureAD cHandle, BOOL newVal);

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
BOOL CkAuthAzureAD_getValid(HCkAuthAzureAD cHandle);
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
BOOL CkAuthAzureAD_getVerboseLogging(HCkAuthAzureAD cHandle);
void CkAuthAzureAD_putVerboseLogging(HCkAuthAzureAD 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.

top
Version
void CkAuthAzureAD_getVersion(HCkAuthAzureAD cHandle, HCkString retval);
const char *CkAuthAzureAD_version(HCkAuthAzureAD cHandle);

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

top

Methods

ObtainAccessToken
BOOL CkAuthAzureAD_ObtainAccessToken(HCkAuthAzureAD cHandle, HCkSocket 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 login.microsoftonline.com.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
ObtainAccessTokenAsync (1)
HCkTask CkAuthAzureAD_ObtainAccessTokenAsync(HCkAuthAzureAD cHandle, HCkSocket connection);
Introduced in version 9.5.0.58

Creates an asynchronous task to call the ObtainAccessToken method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top
SaveLastError
BOOL CkAuthAzureAD_SaveLastError(HCkAuthAzureAD cHandle, const char *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

top