CkAuthAzureAD Python Reference Documentation

CkAuthAzureAD

Current Version: 9.5.0.97

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

obj = chilkat.CkAuthAzureAD()

Properties

AccessToken
# strVal is a string
# ckStr is a CkString
authAzureAD.get_AccessToken(ckStr);
strVal = authAzureAD.accessToken();
authAzureAD.put_AccessToken(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.

More Information and Examples
top
ClientId
# strVal is a string
# ckStr is a CkString
authAzureAD.get_ClientId(ckStr);
strVal = authAzureAD.clientId();
authAzureAD.put_ClientId(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.

top
ClientSecret
# strVal is a string
# ckStr is a CkString
authAzureAD.get_ClientSecret(ckStr);
strVal = authAzureAD.clientSecret();
authAzureAD.put_ClientSecret(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.

top
DebugLogFilePath
# strVal is a string
# ckStr is a CkString
authAzureAD.get_DebugLogFilePath(ckStr);
strVal = authAzureAD.debugLogFilePath();
authAzureAD.put_DebugLogFilePath(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.

top
LastErrorHtml
# strVal is a string
# ckStr is a CkString
authAzureAD.get_LastErrorHtml(ckStr);
strVal = authAzureAD.lastErrorHtml();

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
# strVal is a string
# ckStr is a CkString
authAzureAD.get_LastErrorText(ckStr);
strVal = authAzureAD.lastErrorText();

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

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
# boolVal is a boolean
boolVal = authAzureAD.get_LastMethodSuccess();
authAzureAD.put_LastMethodSuccess(boolVal);

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
# intVal is an integer
intVal = authAzureAD.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
Resource
# strVal is a string
# ckStr is a CkString
authAzureAD.get_Resource(ckStr);
strVal = authAzureAD.resource();
authAzureAD.put_Resource(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.

top
TenantId
# strVal is a string
# ckStr is a CkString
authAzureAD.get_TenantId(ckStr);
strVal = authAzureAD.tenantId();
authAzureAD.put_TenantId(strVal);
Introduced in version 9.5.0.58

Your Azure account tenant ID. (If you don't know what it is, Google "how to find my azure tenant id" for help.)

top
Utf8
# boolVal is a boolean
boolVal = authAzureAD.get_Utf8();
authAzureAD.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 = authAzureAD.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 = authAzureAD.get_VerboseLogging();
authAzureAD.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
authAzureAD.get_Version(ckStr);
strVal = authAzureAD.version();

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

More Information and Examples
top

Methods

LoadTaskCaller
# task is a CkTask
status = authAzureAD.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 = authAzureAD.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 True for success, False for failure.

More Information and Examples
top
ObtainAccessTokenAsync (1)
# returns a CkTask
# connection is a CkSocket
ret_task = authAzureAD.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 None on failure

top