Office365Tasks Class

Properties   Methods   Events   Config Settings   Errors  

The Office365Tasks class provides an easy way to manage todo tasks in Microsoft 365.

Syntax

class cloudcalendars.Office365Tasks

Remarks

This class provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the class, first set the authorization property to a valid OAuth token. The Office365Tasks class can be used for creating new tasks/task lists/checklist items; retrieving, updating, or deleting existing tasks/task lists/checklist items; and several other functionalities supported by the Microsoft Graph API.

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property to set the appropriate fields for the chosen o_auth_client_profile and o_auth_grant_type.

The class has the following defaults:

Additionally, depending on how the application is registered (Ex. Multi-tenant) and what o_auth_grant_type is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the o_auth_server_auth_url and o_auth_server_token_url properties. In the case of Client Credentials and Password grant types, it is also required to use the "default" scopes of the app registration. See below for examples of the modified URLs and scopes:

Below is a brief description of the different o_auth_client_profile and o_auth_grant_type values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the authorize method should be called. If the authorization and authentication was successful, then the o_auth_access_token property will be populated. Additionally, if a refresh token was provided the o_auth_refresh_token property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the o_auth_access_token will be expired. When a method that makes requests to the service provider is called or the authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new o_auth_access_token. If the authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the o_auth_grant_type property. To force the component to only check the access token when the authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the o_auth_grant_type property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, o_auth_server_auth_url, and o_auth_server_token_url to be set. When the authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the o_auth_authorization_code property, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the o_auth_refresh_token property is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: Office365Tasks office365task = new Office365Tasks(); office365task.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; office365task.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; office365task.OAuth.ClientId = CLIENT_ID; office365task.OAuth.ClientSecret = CLIENT_SECRET; office365task.Authorize();

Client Credentials

When using the Client Credentials grant type, the class will act as a service instead of authorizing and authenticating as a user. This allows for the class to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, and o_auth_server_token_url to be set. When the authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, and o_auth_server_auth_url to be set. When the authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this o_auth_grant_type the class requires OAuthPasswordGrantUsername, o_auth_client_secret, and o_auth_server_token_url to be set. The o_auth_client_secret should be set to the password of the account instead of a typical secret. In some cases, the o_auth_client_id also needs to be set. When the authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the authorization property before attempting any operations. Setting the authorization property will cause the class to ignore the values set in the o_auth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access user.read mail.readwrite mail.send mailboxsettings.readwrite user.readwrite Contacts.Read Contacts.ReadWrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365task.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Creating a Task List

To create a task list using the Office365Tasks components we make use of the create_task_list method. The create_task_list method will create a new task list with a name specified through the name parameter.

Creating a task list: office365task.CreateTaskList("My tasklist");

After creating a task list with the basic information, select the task list to be edited in the task_lists collection, edit its fields and make a call to the update_task_list method. To edit the newly created task list select the first task list in the collection.

Example (Update The First Task List Of The Collection) // Set a new name for the newly created task list office365task.TaskLists[0].DisplayName = "new name"; office365task.UpdateTaskList(0);

Listing Task Lists

Information about task lists fetched by the component can be accessed through the members of the task_lists properties. The task_lists properties is populated when the list_task_lists method is called.

The list_task_lists method will list the task lists and make the on_task_list_list event to fire with the appropriate data about the task lists received.

By default, the component will fetch one page of 100 task lists when list_task_lists is called. If additional task lists remain, the ListTaskListsMarker property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if list_task_lists is then called again, if called the next page of task lists will be fetched. The example below populates the task_lists properties with all the task lists associated with the account. do { office365task.ListTaskLists(); } while (office365task.Config("ListTaskListsMarker").Length > 0);

The task lists page size may also be changed by using the TaskListsPageSize configuration setting.

Deleting a Task List

To delete a task list use the delete_task_list method, provide the Id of the task list as the argument. The task list will stay in the task_lists collection until list_task_lists method is called again.

Example (Delete Task List)

// List task lists and deleting the task list named "new name" office365task.ListTaskLists(); for (int i = 0; i < office365task.TaskLists.Count; i++) { if (office365task.TaskLists[i].DisplayName == "new name") { office365task.DeleteTaskList(office365task.TaskLists[i].Id); break; } // Note: the component would let you name more than one task list with the same name so the example would delete the first encounter with the task list that has the specified name }

Creating a Task

To create a task using the Office365Tasks components we make use of the create_task method. The create_task method will create a new task with a name specified through the subject parameter inside the task list specified through the taskListId parameter.

Creating a task: office365task.CreateTaskList("My task list"); office365task.CreateTask("My task", office365task.TaskLists[0].Id); //creating a task named "My task" inside the "My task list" task list

After creating a task with the basic information, select the task to be edited in the tasks collection, edit its fields and make a call to the update_task method. To edit the newly created task select the first task in the collection.

Example (Update The First Task Of The Collection) // Set properties to update office365task.Tasks[0].Title = "new title"; office365task.Tasks[0].Categories = "new category"; office365task.Tasks[0].Importance = TOTImportances.otiNormal; office365task.Tasks[0].IsReminderOn = true; office365task.UpdateTask(0);

Listing Tasks

Information about tasks fetched by the component can be accessed through the members of the tasks properties. The tasks properties is populated when the list_tasks method is called.

The list_tasks method will list the tasks inside the task list specified through the taskListId parameter and make the on_task_list event to fire with the appropriate data about the tasks received.

By default, the component will fetch one page of 100 tasks when list_tasks is called. If additional tasks remain, the list_tasks_marker property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if list_tasks is then called again, if called the next page of tasks will be fetched. The example below populates the tasks properties with all the tasks associated with a task list. do { office365task.ListTasks(office365task.TaskLists[0].Id); } while(office365task.ListTasksMarker.Length > 0)

Deleting a Task

To delete a task use the delete_task method, provide the Id of the task list where the task belongs to and the Id of the task you want to delete as arguments. The task will stay in the tasks collection until list_tasks method is called again.

Example (Delete Task)

// List tasks and deleting the task named "new title" office365task.ListTasks(office365task.TaskLists[0].Id); for (int i = 0; i < office365task.Tasks.Count; i++) { if (office365task.Tasks[i].Title == "new title") { office365task.DeleteTask(office365task.TaskLists[0].Id, office365task.Task[i].Id); break; } // Note: the component would let you name more than one task with the same name so the example would delete the first encounter with the task that has the specified name }

Creating a Checklist Item

To create a checklist item using the Office365Tasks components we make use of the create_check_list_item. The create_check_list_item method will create a new checklist item with a name specified through the name parameter belonging to a task specified through the taskId parameter inside the task list specified through the taskListId parameter.

Creating a checklist item: office365task.CreateTaskList("My task list"); office365task.CreateTask("My task", office365task.TaskLists[0].Id); //creating a task named "My task" inside the "My task list" task list office365task.CreateCheckListItem("My checklist item", office365task.TaskLists[0].Id, office365task.Tasks[0].Id); // creating a checklist item named "My checklist item" inside the "My task" task

After creating a checklist item with the basic information, select the checklist item to be edited in the check_list_items collection, edit its fields and make a call to the update_check_list_item method. To edit the newly created checklist item select the first checklist item in the collection.

Example (Update The First checklist item Of The collection) // Set properties to update office365task.CheckListItems[0].DisplayName = "new name"; office365task.CheckListItems[0].IsChecked= true; office365task.UpdateCheckListItem(0);

Listing Checklist Items

Information about checklist item fetched by the component can be accessed through the members of the check_list_items properties. The check_list_items properties is populated when the list_check_list_items method is called.

The list_check_list_items method will list the checklist items belonging to a task specified through the taskId inside the task list specified through the taskListId parameter and make the on_check_list_item_list event to fire with the appropriate data about the checklist items received. office365task.ListCheckListItems(office365task.TaskLists[0].Id, office365task.Tasks[0].Id);

Deleting a Checklist Item

To delete a checklist item use the delete_check_list_item method, provide the Id of the task list where the task that has the checklist item you want to delete is, the id of the task that has the checklist item you want to delete and finally the Id of the checklist item you want to delete as arguments. The checklist item will stay in the check_list_items collection until list_check_list_items method is called again.

Example (Delete Checklist Item)

// List checklist items and deleting the checklist item named "new name" office365task.ListCheckListItems(office365task.TaskLists[0].Id, office365task.Tasks[0].Id); for (int i = 0; i < office365task.CheckListItems.Count; i++) { if (office365task.CheckListItems[i].DisplayName == "new name") { office365task.DeleteCheckListItem(office365task.TaskLists[0].Id, office365task.Tasks[0].Id, office365task.CheckListItems[i].Id); break; } // Note: the component would let you name more than one checklist item with the same name so the example would delete the first encounter with the checklist item that has the specified name }

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

attachments_count Property

The number of records in the Attachment arrays.

Syntax

def get_attachments_count() -> int: ...
def set_attachments_count(value: int) -> None: ...

attachments_count = property(get_attachments_count, set_attachments_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• attachment_content_type
• attachment_data
• attachment_file_name
• attachment_id
• attachment_json
• attachment_last_modified_date
• attachment_name
• attachment_size
• attachment_task_id
• attachment_task_list_id

The array indices start at 0 and end at attachments_count - 1.

attachment_content_type Property

This property contains the content type of the attachment.

Syntax

def get_attachment_content_type(attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the content type of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachments_count property.

This property is read-only.

attachment_data Property

This property contains the raw data of the attachment.

Syntax

def get_attachment_data(attachment_index: int) -> bytes: ...
def set_attachment_data(attachment_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

This field contains the raw data of the attachment. Only after calling the RetrieveAttachment method

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachments_count property.

attachment_file_name Property

This property contains the local file name associated with the attachment.

Syntax

def get_attachment_file_name(attachment_index: int) -> str: ...
def set_attachment_file_name(attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the local file name associated with the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachments_count property.

attachment_id Property

This property contains the attachment identifier of the attachment.

Syntax

def get_attachment_id(attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the attachment identifier of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachments_count property.

This property is read-only.

attachment_json Property

A JSON representation of the attachment.

Syntax

def get_attachment_json(attachment_index: int) -> str: ...
def set_attachment_json(attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

A JSON representation of the attachment. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachments_count property.

attachment_last_modified_date Property

This property contains the date and time when the attachment was last modified.

Syntax

def get_attachment_last_modified_date(attachment_index: int) -> str: ...
def set_attachment_last_modified_date(attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the date and time when the attachment was last modified.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachments_count property.

attachment_name Property

This property contains the name of the attachment.

Syntax

def get_attachment_name(attachment_index: int) -> str: ...
def set_attachment_name(attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the name of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachments_count property.

attachment_size Property

This property contains the size in bytes of the attachment.

Syntax

def get_attachment_size(attachment_index: int) -> int: ...
def set_attachment_size(attachment_index: int, value: int) -> None: ...

Default Value

0

Remarks

This field contains the size in bytes of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachments_count property.

attachment_task_id Property

This property contains the task identifier of the attachment.

Syntax

def get_attachment_task_id(attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the task identifier of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachments_count property.

This property is read-only.

attachment_task_list_id Property

The ID of the task list that contains the task.

Syntax

def get_attachment_task_list_id(attachment_index: int) -> str: ...

Default Value

""

Remarks

The ID of the task list that contains the task.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachments_count property.

This property is read-only.

authorization Property

An OAuth Authorization String.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

Default Value

""

Remarks

This property is used to specify an OAuth authorization string. Setting it is a requirement for using the component.

Example

Oauth oauth = new Oauth(); oauth.ClientId = "YourClientId"; oauth.ClientSecret = "YourClientSecret"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "user.read"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365tasks.Authorization = oauth.GetAuthorization();

check_list_items_count Property

The number of records in the CheckListItem arrays.

Syntax

def get_check_list_items_count() -> int: ...
def set_check_list_items_count(value: int) -> None: ...

check_list_items_count = property(get_check_list_items_count, set_check_list_items_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• check_list_item_checked_date_time
• check_list_item_created_date_time
• check_list_item_display_name
• check_list_item_id
• check_list_item_is_checked
• check_list_item_task_id
• check_list_item_task_list_id

The array indices start at 0 and end at check_list_items_count - 1.

check_list_item_checked_date_time Property

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Syntax

def get_check_list_item_checked_date_time(check_list_item_index: int) -> str: ...

Default Value

""

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The check_list_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_list_items_count property.

This property is read-only.

check_list_item_created_date_time Property

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Syntax

def get_check_list_item_created_date_time(check_list_item_index: int) -> str: ...

Default Value

""

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The check_list_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_list_items_count property.

This property is read-only.

check_list_item_display_name Property

Indicates the title of the checklistItem.

Syntax

def get_check_list_item_display_name(check_list_item_index: int) -> str: ...
def set_check_list_item_display_name(check_list_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Indicates the title of the checklistItem.

The check_list_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_list_items_count property.

check_list_item_id Property

The unique identifier of the task.

Syntax

def get_check_list_item_id(check_list_item_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of the task.

The check_list_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_list_items_count property.

This property is read-only.

check_list_item_is_checked Property

State that indicates whether the item is checked off or not.

Syntax

def get_check_list_item_is_checked(check_list_item_index: int) -> bool: ...
def set_check_list_item_is_checked(check_list_item_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

State that indicates whether the item is checked off or not.

The check_list_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_list_items_count property.

check_list_item_task_id Property

The ID of the task that contains the subtask.

Syntax

def get_check_list_item_task_id(check_list_item_index: int) -> str: ...

Default Value

""

Remarks

The ID of the task that contains the subtask.

The check_list_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_list_items_count property.

This property is read-only.

check_list_item_task_list_id Property

The ID of the task list that contains the task.

Syntax

def get_check_list_item_task_list_id(check_list_item_index: int) -> str: ...

Default Value

""

Remarks

The ID of the task list that contains the task.

The check_list_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_list_items_count property.

This property is read-only.

firewall_auto_detect Property

Whether to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use firewall system settings, if available.

firewall_type Property

The type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

firewall_host Property

The name or IP address of the firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

A password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

A username if authentication is to be used when connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

list_tasks_marker Property

The page marker for listing tasks.

Syntax

def get_list_tasks_marker() -> str: ...
def set_list_tasks_marker(value: str) -> None: ...

list_tasks_marker = property(get_list_tasks_marker, set_list_tasks_marker)

Default Value

""

Remarks

This property is populated if there are still unlisted tasks after list_tasks is called. It contains the nextLink that will be included as an OData parameter if list_tasks is called again. This will cause the next page of tasks to be listed and added to the end of the tasks collection.

o_auth_access_token Property

The access token returned by the authorization server.

Syntax

def get_o_auth_access_token() -> str: ...
def set_o_auth_access_token(value: str) -> None: ...

o_auth_access_token = property(get_o_auth_access_token, set_o_auth_access_token)

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

o_auth_authorization_code Property

The authorization code that is exchanged for an access token.

Syntax

def get_o_auth_authorization_code() -> str: ...
def set_o_auth_authorization_code(value: str) -> None: ...

o_auth_authorization_code = property(get_o_auth_authorization_code, set_o_auth_authorization_code)

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the o_auth_client_profile property is set to the Web profile. Otherwise, this field is for information purposes only.

o_auth_authorization_scope Property

The scope request or response parameter used during authorization.

Syntax

def get_o_auth_authorization_scope() -> str: ...
def set_o_auth_authorization_scope(value: str) -> None: ...

o_auth_authorization_scope = property(get_o_auth_authorization_scope, set_o_auth_authorization_scope)

Default Value

""

Remarks

The scope request or response parameter used during authorization.

o_auth_client_id Property

The id of the client assigned when registering the application.

Syntax

def get_o_auth_client_id() -> str: ...
def set_o_auth_client_id(value: str) -> None: ...

o_auth_client_id = property(get_o_auth_client_id, set_o_auth_client_id)

Default Value

""

Remarks

The id of the client assigned when registering the application.

o_auth_client_profile Property

The type of client that is requesting authorization.

Syntax

def get_o_auth_client_profile() -> int: ...
def set_o_auth_client_profile(value: int) -> None: ...

o_auth_client_profile = property(get_o_auth_client_profile, set_o_auth_client_profile)

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

o_auth_client_secret Property

The secret value for the client assigned when registering the application.

Syntax

def get_o_auth_client_secret() -> str: ...
def set_o_auth_client_secret(value: str) -> None: ...

o_auth_client_secret = property(get_o_auth_client_secret, set_o_auth_client_secret)

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

o_auth_grant_type Property

The OAuth grant type used to acquire an OAuth access token.

Syntax

def get_o_auth_grant_type() -> int: ...
def set_o_auth_grant_type(value: int) -> None: ...

o_auth_grant_type = property(get_o_auth_grant_type, set_o_auth_grant_type)

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

o_auth_refresh_token Property

Specifies the refresh token received from or sent to the authorization server.

Syntax

def get_o_auth_refresh_token() -> str: ...
def set_o_auth_refresh_token(value: str) -> None: ...

o_auth_refresh_token = property(get_o_auth_refresh_token, set_o_auth_refresh_token)

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the o_auth_grant_type property is set to a grant that can use refresh tokens.

o_auth_request_refresh_token Property

Specifies whether the class will request a refresh token during authorization.

Syntax

def get_o_auth_request_refresh_token() -> bool: ...
def set_o_auth_request_refresh_token(value: bool) -> None: ...

o_auth_request_refresh_token = property(get_o_auth_request_refresh_token, set_o_auth_request_refresh_token)

Default Value

TRUE

Remarks

Specifies whether the class will request a refresh token during authorization. By default, this value is True.

When True, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the o_auth_grant_type property is set to cogtAuthorizationCode.

o_auth_return_url Property

The URL where the user (browser) returns after authenticating.

Syntax

def get_o_auth_return_url() -> str: ...
def set_o_auth_return_url(value: str) -> None: ...

o_auth_return_url = property(get_o_auth_return_url, set_o_auth_return_url)

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

o_auth_server_auth_url Property

The URL of the authorization server.

Syntax

def get_o_auth_server_auth_url() -> str: ...
def set_o_auth_server_auth_url(value: str) -> None: ...

o_auth_server_auth_url = property(get_o_auth_server_auth_url, set_o_auth_server_auth_url)

Default Value

""

Remarks

The URL of the authorization server.

o_auth_server_token_url Property

The URL of the token server used to obtain the access token.

Syntax

def get_o_auth_server_token_url() -> str: ...
def set_o_auth_server_token_url(value: str) -> None: ...

o_auth_server_token_url = property(get_o_auth_server_token_url, set_o_auth_server_token_url)

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

o_auth_web_auth_url Property

The URL to which the user should be re-directed for authorization.

Syntax

def get_o_auth_web_auth_url() -> str: ...

o_auth_web_auth_url = property(get_o_auth_web_auth_url, None)

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

This property is read-only.

proxy_auth_scheme Property

The type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the class will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

Whether to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

A password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

A username if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_accept_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_accept_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_accept_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_accept_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_accept_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_provider Property

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

ssl_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

ssl_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

ssl_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

ssl_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

task_lists_count Property

The number of records in the TaskList arrays.

Syntax

def get_task_lists_count() -> int: ...
def set_task_lists_count(value: int) -> None: ...

task_lists_count = property(get_task_lists_count, set_task_lists_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• task_list_display_name
• task_list_id
• task_list_is_default
• task_list_is_owner
• task_list_is_shared

The array indices start at 0 and end at task_lists_count - 1.

task_list_display_name Property

the name of the task list.

Syntax

def get_task_list_display_name(task_list_index: int) -> str: ...
def set_task_list_display_name(task_list_index: int, value: str) -> None: ...

Default Value

""

Remarks

the name of the task list

The task_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the task_lists_count property.

task_list_id Property

The unique identifier of the task list.

Syntax

def get_task_list_id(task_list_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of the task list.

The task_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the task_lists_count property.

This property is read-only.

task_list_is_default Property

True if this is the default task list where new tasks are created by default, false otherwise.

Syntax

def get_task_list_is_default(task_list_index: int) -> bool: ...

Default Value

FALSE

Remarks

True if this is the default task list where new tasks are created by default, false otherwise

The task_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the task_lists_count property.

This property is read-only.

task_list_is_owner Property

True if the user is the owner of the given task list.

Syntax

def get_task_list_is_owner(task_list_index: int) -> bool: ...

Default Value

FALSE

Remarks

True if the user is the owner of the given task list.

The task_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the task_lists_count property.

This property is read-only.

task_list_is_shared Property

True if the task list is shared with other users.

Syntax

def get_task_list_is_shared(task_list_index: int) -> bool: ...

Default Value

FALSE

Remarks

True if the task list is shared with other users.

The task_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the task_lists_count property.

This property is read-only.

tasks_count Property

The number of records in the Task arrays.

Syntax

def get_tasks_count() -> int: ...
def set_tasks_count(value: int) -> None: ...

tasks_count = property(get_tasks_count, set_tasks_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• task_body
• task_body_last_modified_date_time
• task_categories
• task_completed_date_time
• task_completed_time_zone
• task_created_date_time
• task_due_date_time
• task_due_time_zone
• task_has_attachments
• task_id
• task_importance
• task_is_reminder_on
• task_json
• task_last_modified_date_time
• task_list_display_name
• task_list_id
• task_list_is_default
• task_list_is_owner
• task_list_is_shared
• task_recur_day_of_month
• task_recur_days_of_week
• task_recur_end_date
• task_recur_first_day_of_week
• task_recur_index
• task_recur_interval
• task_recur_month
• task_recur_number_of_occurrences
• task_recur_range_type
• task_recur_start_date
• task_recur_time_zone
• task_recur_type
• task_reminder_date_time
• task_reminder_time_zone
• task_start_date_time
• task_start_time_zone
• task_status
• task_task_list_id
• task_title

The array indices start at 0 and end at tasks_count - 1.

task_body Property

The task body that typically contains information about the task.

Syntax

def get_task_body(task_index: int) -> str: ...
def set_task_body(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The task body that typically contains information about the task. Note that only HTML type is supported.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_body_last_modified_date_time Property

The date and time when the task body was last modified.

Syntax

def get_task_body_last_modified_date_time(task_index: int) -> str: ...

Default Value

""

Remarks

The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

This property is read-only.

task_categories Property

The categories associated with the task.

Syntax

def get_task_categories(task_index: int) -> str: ...
def set_task_categories(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory defined for the user.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_completed_date_time Property

The date and time the task was finished.

Syntax

def get_task_completed_date_time(task_index: int) -> str: ...
def set_task_completed_date_time(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The date and time the task was finished.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_completed_time_zone Property

The time zone of the time the task was finished.

Syntax

def get_task_completed_time_zone(task_index: int) -> str: ...
def set_task_completed_time_zone(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The time zone of the time the task was finished.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_created_date_time Property

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Syntax

def get_task_created_date_time(task_index: int) -> str: ...

Default Value

""

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

This property is read-only.

task_due_date_time Property

The date and time the task is to be finished.

Syntax

def get_task_due_date_time(task_index: int) -> str: ...
def set_task_due_date_time(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The date and time the task is to be finished.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_due_time_zone Property

The time zone of the time the task is to be finished.

Syntax

def get_task_due_time_zone(task_index: int) -> str: ...
def set_task_due_time_zone(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The time zone of the time the task is to be finished.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_has_attachments Property

Set to true if the task has attachments.

Syntax

def get_task_has_attachments(task_index: int) -> bool: ...

Default Value

FALSE

Remarks

Set to true if the task has attachments.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

This property is read-only.

task_id Property

The unique identifier of the task.

Syntax

def get_task_id(task_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of the task.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

This property is read-only.

task_importance Property

The importance of the task.

Syntax

def get_task_importance(task_index: int) -> int: ...
def set_task_importance(task_index: int, value: int) -> None: ...

Default Value

0

Remarks

The importance of the task.

Possible values are:

• 0 (otiLow)
• 1 (otiNormal)
• 2 (otiHigh)

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_is_reminder_on Property

Set to true if an alert is set to remind the user of the task.

Syntax

def get_task_is_reminder_on(task_index: int) -> bool: ...
def set_task_is_reminder_on(task_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Set to true if an alert is set to remind the user of the task.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_json Property

A JSON representation of the task.

Syntax

def get_task_json(task_index: int) -> str: ...
def set_task_json(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

A JSON representation of the task. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_last_modified_date_time Property

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Syntax

def get_task_last_modified_date_time(task_index: int) -> str: ...

Default Value

""

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

This property is read-only.

task_recur_day_of_month Property

The day of the month on which the task occurs.

Syntax

def get_task_recur_day_of_month(task_index: int) -> int: ...
def set_task_recur_day_of_month(task_index: int, value: int) -> None: ...

Default Value

0

Remarks

The day of the month on which the task occurs. Required if type is absoluteMonthly or absoluteYearly.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_days_of_week Property

A space separated collection of the days of the week on which the task occurs.

Syntax

def get_task_recur_days_of_week(task_index: int) -> str: ...
def set_task_recur_days_of_week(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

A space separated collection of the days of the week on which the task occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the task falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_end_date Property

The date to stop applying the recurrence pattern.

Syntax

def get_task_recur_end_date(task_index: int) -> str: ...
def set_task_recur_end_date(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the task, the last occurrence of the meeting may not be this date. Required if type is endDate.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_first_day_of_week Property

The first day of the week.

Syntax

def get_task_recur_first_day_of_week(task_index: int) -> str: ...
def set_task_recur_first_day_of_week(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The first day of the week. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. Default is sunday. Required if type is weekly.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_index Property

Specifies on which instance of the allowed days specified in daysOfWeek the task occurs, counted from the first instance in the month.

Syntax

def get_task_recur_index(task_index: int) -> str: ...
def set_task_recur_index(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

Specifies on which instance of the allowed days specified in daysOfWeek the task occurs, counted from the first instance in the month. The possible values are: first, second, third, fourth, last. Default is first. Optional and used if type is relativeMonthly or relativeYearly.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_interval Property

The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.

Syntax

def get_task_recur_interval(task_index: int) -> int: ...
def set_task_recur_interval(task_index: int, value: int) -> None: ...

Default Value

0

Remarks

The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required. Set to 0 to disable recurrence.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_month Property

The month in which the task occurs.

Syntax

def get_task_recur_month(task_index: int) -> int: ...
def set_task_recur_month(task_index: int, value: int) -> None: ...

Default Value

0

Remarks

The month in which the task occurs. This is a number from 1 to 12.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_number_of_occurrences Property

The number of times to repeat the task.

Syntax

def get_task_recur_number_of_occurrences(task_index: int) -> int: ...
def set_task_recur_number_of_occurrences(task_index: int, value: int) -> None: ...

Default Value

0

Remarks

The number of times to repeat the task. Required and must be positive if type is numbered.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_range_type Property

The recurrence range.

Syntax

def get_task_recur_range_type(task_index: int) -> int: ...
def set_task_recur_range_type(task_index: int, value: int) -> None: ...

Default Value

0

Remarks

The recurrence range.

Possible values are:

• 0 (otrrtEndDate)
• 1 (otrrtNoEnd)
• 2 (otrrtNumbered)

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_start_date Property

The date to start applying the recurrence pattern.

Syntax

def get_task_recur_start_date(task_index: int) -> str: ...
def set_task_recur_start_date(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the task. Must be the same value as the start property of the recurring task. Required.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_time_zone Property

Time zone for the startDate and endDate properties.

Syntax

def get_task_recur_time_zone(task_index: int) -> str: ...
def set_task_recur_time_zone(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_recur_type Property

The recurrence pattern type Possible values are: 0 (otrtDaily) 1 (otrtWeekly) 2 (otrtAbsoluteMonthly) 3 (otrtRelativeMonthly) 4 (otrtAbsoluteYearly) 5 (otrtRelativeYearly) .

Syntax

def get_task_recur_type(task_index: int) -> int: ...
def set_task_recur_type(task_index: int, value: int) -> None: ...

Default Value

0

Remarks

The recurrence pattern type

Possible values are:

• 0 (otrtDaily)
• 1 (otrtWeekly)
• 2 (otrtAbsoluteMonthly)
• 3 (otrtRelativeMonthly)
• 4 (otrtAbsoluteYearly)
• 5 (otrtRelativeYearly)

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_reminder_date_time Property

The date and time for a reminder alert of the task to occur.

Syntax

def get_task_reminder_date_time(task_index: int) -> str: ...
def set_task_reminder_date_time(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The date and time for a reminder alert of the task to occur.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_reminder_time_zone Property

The time zone of the time for a reminder alert of the task to occur.

Syntax

def get_task_reminder_time_zone(task_index: int) -> str: ...
def set_task_reminder_time_zone(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The time zone of the time for a reminder alert of the task to occur.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_start_date_time Property

The date and time at which the task is scheduled to start.

Syntax

def get_task_start_date_time(task_index: int) -> str: ...
def set_task_start_date_time(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The date and time at which the task is scheduled to start.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_start_time_zone Property

The time zone of the time at which the task is scheduled to start.

Syntax

def get_task_start_time_zone(task_index: int) -> str: ...
def set_task_start_time_zone(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

The time zone of the time at which the task is scheduled to start.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_status Property

The status of the task.

Syntax

def get_task_status(task_index: int) -> int: ...
def set_task_status(task_index: int, value: int) -> None: ...

Default Value

0

Remarks

The status of the task.

Possible values are:

• 0 (otsNotStarted)
• 1 (otsInProgress)
• 2 (otsCompleted)
• 3 (otsWaitingOnOthers)
• 4 (otsDeferred)

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

task_task_list_id Property

The ID of the task list that contains the task.

Syntax

def get_task_task_list_id(task_index: int) -> str: ...

Default Value

""

Remarks

The ID of the task list that contains the task.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

This property is read-only.

task_title Property

A brief description of the task.

Syntax

def get_task_title(task_index: int) -> str: ...
def set_task_title(task_index: int, value: str) -> None: ...

Default Value

""

Remarks

A brief description of the task.

The task_index parameter specifies the index of the item in the array. The size of the array is controlled by the tasks_count property.

add_attachment Method

Adds a file attachment to an existing task.

Syntax

def add_attachment(task_list_id: str, task_id: str, name: str, local_file: str) -> None: ...

Remarks

This method adds a file attachment to an existing task, specified by the TaskId parameter. To add a more complex attachment, set the Name and LocalFile parameters to empty strings and the class will use the first attachment in the attachments properties. As a note, this will not clear the attachments properties. If the file is larger than the value set in the AttachmentSimpleUploadLimit configuration, then the class will use an upload session to upload the attachment in fragments. The size of the fragments are specified in the AttachmentFragmentSize configuration. To add an attachment from stream use the set_attachment_in_stream method.

authorize Method

Get the authorization string required to access the protected resource.

Syntax

def authorize() -> None: ...

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the o_auth_client_profile property and the o_auth_grant_type property. This method is not to be used in conjunction with the authorization property. It should instead be used when setting the o_auth property.

For more information, see the introduction section.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_check_list_item Method

Creates a subtask.

Syntax

def create_check_list_item(subject: str, task_list_id: str, task_id: str) -> None: ...

Remarks

Creates a subtask from the specified taskListId and taskId with the specified name. The subject parameter defines the name of the subtask.

The name of the subtask can be updated after creation by calling the update_check_list_item method.

create_task Method

Creates a task.

Syntax

def create_task(subject: str, task_list_id: str) -> None: ...

Remarks

Creates a new task from the specified taskListId with the specified name. The subject parameter defines the name of the task.

The name of the task can be updated after creation by calling the update_task method.

create_task_list Method

Creates a new task list.

Syntax

def create_task_list(name: str) -> None: ...

Remarks

Creates a new task list with the specified name. The name parameter defines the name of the task list.

The name of the task list can be updated after creation by calling the update_task_list method.

delete_attachment Method

Deletes an attachment.

Syntax

def delete_attachment(task_list_id: str, task_id: str, id: str) -> None: ...

Remarks

This method deletes an attachment. id takes the ID of the task the attachment is attached to. attachmentId takes the attachment ID of an existing attachment. This will not remove the attachment from the attachments properties.

delete_check_list_item Method

Deletes a subtask.

Syntax

def delete_check_list_item(task_list_id: str, task_id: str, id: str) -> None: ...

Remarks

Deletes a subtask identified by taskListId, taskId and id parameters. taskListId and taskIdthe parameters identifies the Task list and Task that the subtask to be deleted belongs to and id parameter identifies the subtask to be deleted. The specified subtask will be permanently removed. This operation will not remove the subtask from the check_list_items collection

delete_task Method

Deletes a task.

Syntax

def delete_task(task_list_id: str, id: str) -> None: ...

Remarks

Deletes a task identified by taskListId and id parameters. taskListId parameter identifies the Task list that the task to be deleted belongs to and id parameter identifies the task to be deleted. The specified task will be permanently removed. This operation will not remove the task from the tasks collection

delete_task_list Method

Deletes a task list.

Syntax

def delete_task_list(id: str) -> None: ...

Remarks

Deletes a Task list identified by the id parameter. The Task list and all its associated tasks will be removed, this operation will not remove the Task list from the task_lists collection.

get_check_list_item Method

Retrieves the subtask by Id.

Syntax

def get_check_list_item(task_list_id: str, task_id: str, id: str) -> None: ...

Remarks

This method retrieves a subtask specified by its ID and adds the subtask to the beginning of the check_list_items list. If the subtask already exists in the check_list_items collection, it will be removed and then added to the beginning, preventing duplication.

Example(Retrieving a subtask) office365task.GetCheckListItem("taskListId", "taskId", "id"); office365task.CheckListItems[0]; //the retrieved subtask

get_task Method

Retrieves the task by Id.

Syntax

def get_task(task_list_id: str, id: str) -> None: ...

Remarks

This method retrieves a task specified by its ID and adds the task to the beginning of the tasks list. If the task already exists in the tasks collection, it will be removed and then added to the beginning, preventing duplication.

Example(Retrieving a task) office365task.GetTask("taskListId", "id"); office365task.Tasks[0]; //the retrieved task

get_task_field Method

Retrieves the task property value by JSONPath.

Syntax

def get_task_field(index: int, json_path: str) -> str: ...

Remarks

This method retrieves a specific field within the task's JSON field. The first parameter, index, represents the index of the task in the tasks collection from which to retrieve the field. The second parameter, JsonPath, is the JSON path to the field you want to retrieve. Please refer to XPath for more details on how to set the Json path. The method returns a string that represents the value of the specified JSON field.

Example (Access Fields of a Task)

office365task.GetTaskField(0, "/json/title"); // The title of the task

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_attachments Method

Lists all of a task's attachments.

Syntax

def list_attachments(task_list_id: str, task_id: str) -> None: ...

Remarks

This method lists all of a task's attachments. This method clears and populates the attachments properties. For each attachment retrieved, the on_attachment_list event is fired.

list_check_list_items Method

Lists the subtasks.

Syntax

def list_check_list_items(task_list_id: str, task_id: str) -> None: ...

Remarks

Retrieves a list of subtasks from the specified Task, identified by the taskListId and the taskId parameters. The retrieved subtasks are added to the check_list_items collection. For each subtask retrieved, the on_check_list_item_list event is fired.

list_task_lists Method

Lists the task lists.

Syntax

def list_task_lists() -> None: ...

Remarks

List all Task lists associated with the current user. The retrieved Task lists are added to the task_lists collection. For each Task list retrieved, the on_task_list_list event is fired.

list_tasks Method

Lists the tasks.

Syntax

def list_tasks(task_list_id: str) -> None: ...

Remarks

Retrieves a list of tasks from the specified Task list, identified by the taskListId parameter. The retrieved Task lists are added to the tasks collection. For each Task list retrieved, the on_task_list event is fired.

reset Method

This method will reset the class.

Syntax

def reset() -> None: ...

Remarks

This method will reset the class's properties to their default values.

retrieve_attachment Method

Retrieves a task's attachment.

Syntax

def retrieve_attachment(task_list_id: str, task_id: str, id: str) -> None: ...

Remarks

This method retrieves an attachment. id specifies the task ID for the task the attachment is attached to. The content data returns in this case

The fetched attachment can be accessed through the Attachment* properties.

send_custom_request Method

Send a custom HTTP request.

Syntax

def send_custom_request(http_method: str, url: str, post_data: str) -> None: ...

Remarks

This method can be used to send a custom HTTP request to the server.

set_task_field Method

Sets the task field value by JSONPath.

Syntax

def set_task_field(index: int, json_path: str, value: str, value_type: int) -> None: ...

Remarks

This method updates a specific field within the event's JSON representation. The parameters for this method are as follows: the first parameter, index, represents the index of the event in the tasks collection to be edited. The second parameter, JsonPath, specifies the JSON path to the field you want to set. Please refer to XPath for more details on how to set the Json path. The third parameter, Value, is the value to be assigned to the JSON field. The fourth parameter, ValueType, is the type of the value, which must be one of the defined types:

• 0 (Object)
• 1 (Array)
• 2 (String)
• 3 (Number)
• 4 (Bool)
• 5 (Null)
• 6 (Raw)

Example (Set/Edit Fields of a Task before Updating): // Create a task office365task.CreateTask("task name", taskListId); office365task.SetTaskField(0, "/json/body", "Task body", 2); // Update notes field office365task.SetTaskField(0, "/json/title", "new task name", 2); // Update title field // Update task office365task.UpdateTask(0);

For a full list of the fields a task has/can have, please refer to the official documentation of the Microsoft Graph API documentation.

update_check_list_item Method

Updates a subtask.

Syntax

def update_check_list_item(index: int) -> None: ...

Remarks

This method allows you to update an existing subtask. The index parameter specifies the position of the task in the check_list_items collection. The method uses this index to take all the data from the specified subtask and update the corresponding subtask on the server.

To update a subtask, edit the desired task fields within the check_list_items collection. Then, call the update_check_list_item method with the index of the subtask. Note that changing the JSON data will overwrite the entire subtask, ignoring other field edits made before setting the JSON.

The OTCheckListItem type used in the check_list_items collection includes the fields of a subtask. Refer to the OTCheckListItem type for a complete list of fields.

update_task Method

Updates a task.

Syntax

def update_task(index: int) -> None: ...

Remarks

This method allows you to update an existing task. The index parameter specifies the position of the task in the tasks collection. The method uses this index to take all the data from the specified task and update the corresponding task on the server.

To update a task, edit the desired task fields within the tasks collection. Then, call the update_task method with the index of the task. Note that changing the JSON data will overwrite the entire task, ignoring other field edits made before setting the JSON.

The OTTaskItem type used in the tasks collection includes the fields of a task. Refer to the OTTaskItem type for a complete list of fields. If you need to add other fields, you can use the set_task_field method. For a complete list of fields a task can have, please refer to the Microsoft Graph API overview

update_task_list Method

Updates a task list.

Syntax

def update_task_list(index: int) -> None: ...

Remarks

This method allows you to update an existing task list. The index parameter specifies the position of the task list in the task_lists collection. The method uses this index to take all the data from the specified task list and update the corresponding task list on the server.

To update a task list, edit the desired task list fields within the task_lists collection. Then, call the update_task_list method with the index of the task list. Note that changing the JSON data will overwrite the entire task list, ignoring other field edits made before setting the JSON.

The OTTaskList type used in the task_lists collection includes the fields of a task list. Refer to the OTTaskList type for a complete list of fields.

on_attachment_list Event

Fired when an attachment is retrieved from the server.

Syntax

class Office365TasksAttachmentListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def name() -> str: ...

  @property
  def content_type() -> str: ...

  @property
  def last_modified_date_time() -> str: ...

  @property
  def size() -> int: ...

# In class Office365Tasks:
@property
def on_attachment_list() -> Callable[[Office365TasksAttachmentListEventParams], None]: ...
@on_attachment_list.setter
def on_attachment_list(event_hook: Callable[[Office365TasksAttachmentListEventParams], None]) -> None: ...

Remarks

The on_attachment_list event is fired for each attachment retrieved from the server when list_attachments is called. This event provides the attachment's Id, Name, ContentType, LastModifiedDateTime and Size.

on_check_list_item_list Event

Fired when a subtask is retrieved from the server.

Syntax

class Office365TasksCheckListItemListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def task_id() -> str: ...

  @property
  def task_list_id() -> str: ...

  @property
  def subject() -> str: ...

# In class Office365Tasks:
@property
def on_check_list_item_list() -> Callable[[Office365TasksCheckListItemListEventParams], None]: ...
@on_check_list_item_list.setter
def on_check_list_item_list(event_hook: Callable[[Office365TasksCheckListItemListEventParams], None]) -> None: ...

Remarks

The on_check_list_item_list event is fired for each subtask retrieved from the server when list_check_list_items is called. This event provides the subtask's Id, TaskId, TaskListId and Subject.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class Office365TasksErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class Office365Tasks:
@property
def on_error() -> Callable[[Office365TasksErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[Office365TasksErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_log Event

Fired once for each log message.

Syntax

class Office365TasksLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class Office365Tasks:
@property
def on_log() -> Callable[[Office365TasksLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[Office365TasksLogEventParams], None]) -> None: ...

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class Office365TasksSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class Office365Tasks:
@property
def on_ssl_server_authentication() -> Callable[[Office365TasksSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[Office365TasksSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class Office365TasksSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class Office365Tasks:
@property
def on_ssl_status() -> Callable[[Office365TasksSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[Office365TasksSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_task_list Event

Fired when a task is retrieved from the server.

Syntax

class Office365TasksTaskListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def task_list_id() -> str: ...

  @property
  def subject() -> str: ...

# In class Office365Tasks:
@property
def on_task_list() -> Callable[[Office365TasksTaskListEventParams], None]: ...
@on_task_list.setter
def on_task_list(event_hook: Callable[[Office365TasksTaskListEventParams], None]) -> None: ...

Remarks

The on_task_list event is fired for each task retrieved from the server when list_tasks is called. This event provides the task's Id, TaskListId and Subject.

on_task_list_list Event

Fired when a task list is retrieved from the server.

Syntax

class Office365TasksTaskListListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def name() -> str: ...

# In class Office365Tasks:
@property
def on_task_list_list() -> Callable[[Office365TasksTaskListListEventParams], None]: ...
@on_task_list_list.setter
def on_task_list_list(event_hook: Callable[[Office365TasksTaskListListEventParams], None]) -> None: ...

Remarks

The on_task_list_list event is fired for each task list retrieved from the server when list_task_lists is called. This event provides the task list's Id and Name.

on_transfer Event

Fired while a document transfers (delivers document).

Syntax

class Office365TasksTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class Office365Tasks:
@property
def on_transfer() -> Callable[[Office365TasksTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[Office365TasksTransferEventParams], None]) -> None: ...

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Office365Tasks Config Settings

Office365Tasks Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings