AuthAzureAD Tcl 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)

Object Creation

set myAuthAzureAD [new CkAuthAzureAD]

Properties

AccessToken (string)

# ckStr is a CkString
CkAuthAzureAD_get_AccessToken $myAuthAzureAD $ckStr
set strVal [CkAuthAzureAD_get_accessToken $myAuthAzureAD]
CkAuthAzureAD_put_AccessToken $myAuthAzureAD $strVal

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

ClientId (string)

# ckStr is a CkString
CkAuthAzureAD_get_ClientId $myAuthAzureAD $ckStr
set strVal [CkAuthAzureAD_get_clientId $myAuthAzureAD]
CkAuthAzureAD_put_ClientId $myAuthAzureAD $strVal

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.

ClientSecret (string)

# ckStr is a CkString
CkAuthAzureAD_get_ClientSecret $myAuthAzureAD $ckStr
set strVal [CkAuthAzureAD_get_clientSecret $myAuthAzureAD]
CkAuthAzureAD_put_ClientSecret $myAuthAzureAD $strVal

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.

DebugLogFilePath (string)

# ckStr is a CkString
CkAuthAzureAD_get_DebugLogFilePath $myAuthAzureAD $ckStr
set strVal [CkAuthAzureAD_get_debugLogFilePath $myAuthAzureAD]
CkAuthAzureAD_put_DebugLogFilePath $myAuthAzureAD $strVal

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.

LastErrorHtml (string)

# ckStr is a CkString
CkAuthAzureAD_get_LastErrorHtml $myAuthAzureAD $ckStr
set strVal [CkAuthAzureAD_get_lastErrorHtml $myAuthAzureAD]

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.

LastErrorText (string)

# ckStr is a CkString
CkAuthAzureAD_get_LastErrorText $myAuthAzureAD $ckStr
set strVal [CkAuthAzureAD_get_lastErrorText $myAuthAzureAD]

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

LastErrorXml (string)

# ckStr is a CkString
CkAuthAzureAD_get_LastErrorXml $myAuthAzureAD $ckStr
set strVal [CkAuthAzureAD_get_lastErrorXml $myAuthAzureAD]

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.

LastMethodSuccess (boolean 1/0)

set boolVal [CkAuthAzureAD_get_LastMethodSuccess $myAuthAzureAD]
CkAuthAzureAD_put_LastMethodSuccess $myAuthAzureAD $boolVal

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

NumSecondsRemaining (integer)

set intVal [CkAuthAzureAD_get_NumSecondsRemaining $myAuthAzureAD]

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.

Resource (string)

# ckStr is a CkString
CkAuthAzureAD_get_Resource $myAuthAzureAD $ckStr
set strVal [CkAuthAzureAD_get_resource $myAuthAzureAD]
CkAuthAzureAD_put_Resource $myAuthAzureAD $strVal

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.

TenantId (string)

# ckStr is a CkString
CkAuthAzureAD_get_TenantId $myAuthAzureAD $ckStr
set strVal [CkAuthAzureAD_get_tenantId $myAuthAzureAD]
CkAuthAzureAD_put_TenantId $myAuthAzureAD $strVal

Introduced in version 9.5.0.58

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

Utf8 (boolean 1/0)

set boolVal [CkAuthAzureAD_get_Utf8 $myAuthAzureAD]
CkAuthAzureAD_put_Utf8 $myAuthAzureAD $boolVal

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

Valid (boolean 1/0)

set boolVal [CkAuthAzureAD_get_Valid $myAuthAzureAD]

Introduced in version 9.5.0.58

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

VerboseLogging (boolean 1/0)

set boolVal [CkAuthAzureAD_get_VerboseLogging $myAuthAzureAD]
CkAuthAzureAD_put_VerboseLogging $myAuthAzureAD $boolVal

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.

Version (string)

# ckStr is a CkString
CkAuthAzureAD_get_Version $myAuthAzureAD $ckStr
set strVal [CkAuthAzureAD_get_version $myAuthAzureAD]

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

Methods

# connection is a CkSocket
set status [CkAuthAzureAD_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 login.microsoftonline.com.

Returns 1 for success, 0 for failure.

Get an Azure AD Access Token

# returns a CkTask
# connection is a CkSocket
set ret_task [CkAuthAzureAD_ObtainAccessTokenAsync $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

How to Run an Asynchronous Task

# path is a string
set status [CkAuthAzureAD_SaveLastError $path]

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

Returns 1 for success, 0 for failure.