AuthAzureAD Unicode 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

HCkAuthAzureADW instance = CkAuthAzureADW_Create();
// ...
CkAuthAzureADW_Dispose(instance);
HCkAuthAzureADW CkAuthAzureADW_Create(void);

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

void CkAuthAzureADW_Dispose(HCkAuthAzureADW handle);

Objects created by calling CkAuthAzureADW_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 CkAuthAzureADW_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkAuthAzureADW_setAbortCheck(HCkAuthAzureADW 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 CkAuthAzureADW_setPercentDone(HCkAuthAzureADW 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 CkAuthAzureADW_setProgressInfo(HCkAuthAzureADW cHandle, void (*fnProgressInfo)(const wchar_t *name, const wchar_t *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 CkAuthAzureADW_setTaskCompleted(HCkAuthAzureADW cHandle, void (*fnTaskCompleted)(HCkTaskW 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 CkAuthAzureADW_getAccessToken(HCkAuthAzureADW cHandle, HCkString retval);
void CkAuthAzureADW_putAccessToken(HCkAuthAzureADW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureADW_accessToken(HCkAuthAzureADW 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 CkAuthAzureADW_getClientId(HCkAuthAzureADW cHandle, HCkString retval);
void CkAuthAzureADW_putClientId(HCkAuthAzureADW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureADW_clientId(HCkAuthAzureADW 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 CkAuthAzureADW_getClientSecret(HCkAuthAzureADW cHandle, HCkString retval);
void CkAuthAzureADW_putClientSecret(HCkAuthAzureADW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureADW_clientSecret(HCkAuthAzureADW 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 CkAuthAzureADW_getDebugLogFilePath(HCkAuthAzureADW cHandle, HCkString retval);
void CkAuthAzureADW_putDebugLogFilePath(HCkAuthAzureADW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureADW_debugLogFilePath(HCkAuthAzureADW 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 CkAuthAzureADW_getLastErrorHtml(HCkAuthAzureADW cHandle, HCkString retval);
const wchar_t *CkAuthAzureADW_lastErrorHtml(HCkAuthAzureADW 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 CkAuthAzureADW_getLastErrorText(HCkAuthAzureADW cHandle, HCkString retval);
const wchar_t *CkAuthAzureADW_lastErrorText(HCkAuthAzureADW 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 CkAuthAzureADW_getLastErrorXml(HCkAuthAzureADW cHandle, HCkString retval);
const wchar_t *CkAuthAzureADW_lastErrorXml(HCkAuthAzureADW 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 CkAuthAzureADW_getLastMethodSuccess(HCkAuthAzureADW cHandle);
void CkAuthAzureADW_putLastMethodSuccess(HCkAuthAzureADW 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 CkAuthAzureADW_getNumSecondsRemaining(HCkAuthAzureADW 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 CkAuthAzureADW_getResource(HCkAuthAzureADW cHandle, HCkString retval);
void CkAuthAzureADW_putResource(HCkAuthAzureADW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureADW_resource(HCkAuthAzureADW 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 CkAuthAzureADW_getTenantId(HCkAuthAzureADW cHandle, HCkString retval);
void CkAuthAzureADW_putTenantId(HCkAuthAzureADW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureADW_tenantId(HCkAuthAzureADW 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
Valid
BOOL CkAuthAzureADW_getValid(HCkAuthAzureADW 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 CkAuthAzureADW_getVerboseLogging(HCkAuthAzureADW cHandle);
void CkAuthAzureADW_putVerboseLogging(HCkAuthAzureADW 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 CkAuthAzureADW_getVersion(HCkAuthAzureADW cHandle, HCkString retval);
const wchar_t *CkAuthAzureADW_version(HCkAuthAzureADW cHandle);

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

top

Methods

ObtainAccessToken
BOOL CkAuthAzureADW_ObtainAccessToken(HCkAuthAzureADW cHandle, HCkSocketW 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)
HCkTaskW CkAuthAzureADW_ObtainAccessTokenAsync(HCkAuthAzureADW cHandle, HCkSocketW 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 CkAuthAzureADW_SaveLastError(HCkAuthAzureADW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

top