AuthAzureAD Delphi DLL Reference Documentation

AuthAzureAD

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

function CkAuthAzureAD_Create: HCkAuthAzureAD; stdcall;

Creates an instance of the HCkAuthAzureAD object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkAuthAzureAD_Dispose(handle: HCkAuthAzureAD); stdcall;

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.

Properties

procedure CkAuthAzureAD_getAccessToken(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putAccessToken(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;

function CkAuthAzureAD__accessToken(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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.

Get an Azure AD Access Token

procedure CkAuthAzureAD_getClientId(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putClientId(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;

function CkAuthAzureAD__clientId(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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.

procedure CkAuthAzureAD_getClientSecret(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putClientSecret(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;

function CkAuthAzureAD__clientSecret(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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.

procedure CkAuthAzureAD_getDebugLogFilePath(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putDebugLogFilePath(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;

function CkAuthAzureAD__debugLogFilePath(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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.

procedure CkAuthAzureAD_getLastErrorHtml(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;

function CkAuthAzureAD__lastErrorHtml(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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.

procedure CkAuthAzureAD_getLastErrorText(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;

function CkAuthAzureAD__lastErrorText(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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.

Concept of LastErrorText

LastErrorText Standard Information

procedure CkAuthAzureAD_getLastErrorXml(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;

function CkAuthAzureAD__lastErrorXml(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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.

function CkAuthAzureAD_getLastMethodSuccess(objHandle: HCkAuthAzureAD): wordbool; stdcall;
procedure CkAuthAzureAD_putLastMethodSuccess(objHandle: HCkAuthAzureAD; newPropVal: wordbool); stdcall;

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.

function CkAuthAzureAD_getNumSecondsRemaining(objHandle: HCkAuthAzureAD): Integer; stdcall;

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.

procedure CkAuthAzureAD_getResource(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putResource(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;

function CkAuthAzureAD__resource(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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.

procedure CkAuthAzureAD_getTenantId(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putTenantId(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;

function CkAuthAzureAD__tenantId(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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.

function CkAuthAzureAD_getValid(objHandle: HCkAuthAzureAD): wordbool; stdcall;

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.

function CkAuthAzureAD_getVerboseLogging(objHandle: HCkAuthAzureAD): wordbool; stdcall;
procedure CkAuthAzureAD_putVerboseLogging(objHandle: HCkAuthAzureAD; newPropVal: wordbool); stdcall;

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.

procedure CkAuthAzureAD_getVersion(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;

function CkAuthAzureAD__version(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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

Methods

function CkAuthAzureAD_ObtainAccessToken(objHandle: HCkAuthAzureAD;
    connection: HCkSocket): wordbool; stdcall;

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.

Get an Azure AD Access Token

function CkAuthAzureAD_ObtainAccessTokenAsync(objHandle: HCkAuthAzureAD;
    connection: HCkSocket): HCkTask; stdcall;

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 nil on failure

How to Run an Asynchronous Task

function CkAuthAzureAD_SaveLastError(objHandle: HCkAuthAzureAD;
    path: PWideChar): wordbool; stdcall;

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

Returns True for success, False for failure.