Office365Calendars Class

Properties   Methods   Events   Config Settings   Errors  

The Office365Calendars class provides an easy way to manage calendars in Microsoft 365. The class includes support for creating, listing and managing both calendars and events.

Syntax

class cloudcalendars.Office365Calendars

Remarks

This class provides an easy to use interface for Microsoft Office365 Calendars. To use the class, first set the authorization property to a valid OAuth token. The Office365Calendars class can be used for creating new calendars, retrieving, deleting and updating existing ones; and several other functionalities supported by the Office365 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: Office365Calendars office365 = new Office365Calendars(); office365.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; office365.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; office365.OAuth.ClientId = CLIENT_ID; office365.OAuth.ClientSecret = CLIENT_SECRET; office365.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; office365.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Creating a Calendar

To create a calendar using the Office365Calendars components we make use of the create_calendar method. The create_calendar method will create a new calendar with a name specified through the Name parameter.

Creating a calendar: office365.CreateCalendar("My Calendar");

After creating a calendar, select the calendar to be edited in the calendars collection, edit its fields and make a call to the update_calendar method. To edit the newly created calendar select the first calendar in the collection.

Example (Update The First Calendar Of The Collection) // Set properties to update office365.Calendars[0].Color = TOfficeColors.occLightGreen; office365.Calendars[0].Name = "new name"; office365.UpdateCalendar(0);

Listing Calendars

Information about calendars fetched by the component can be accessed through the calendars properties. The calendars properties is populated when the list_calendars method is called.

By default, the component will fetch one page of 100 calendars when list_calendars is called. If additional calendars remain in the folder, the ListCalendarsMarker property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if list_calendars is then called again on the same folder, if called the next page of calendars will be fetched. The example below populates the calendars properties with all the calendars associated with the account. do { office365.ListCalendars(); } while (office365.Config("ListCalendarsMarker").Length > 0);

Creating Events

To create a new event use the create_event method. The newly created event is added at the beginning of the events properties.

Example (Create a new event in a specific calendar)

office365.CreateEvent("My event", "2024-11-08T16:00:00", "2024-11-08T17:00:00", office365.Calendars[0].Id); // The ID of the calendar to which the event will belong to

After creating an event with the basic information, select the event to be edited in the events collection, edit its fields and make a call to the update_event method. To edit the newly created event select the first event in the collection.

Example (Update The First Event Of The List) // Set properties to update office365.Events[0].Subject = "new event name"; office365.Events[0].AttendeesCount = 2; office365.Events[0].AttendeeIndex = 0; office365.Events[0].AttendeeEmail = "person1@example.com"; office365.Events[0].AttendeeStatusResponse = TOCAttendeeStatusResponses.oasrAccepted; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatOptional; office365.Events[0].AttendeeIndex = 1; office365.Events[0].AttendeeEmail = "person2@example.com"; office365.Events[0].AttendeeStatusResponse = TOCAttendeeStatusResponses.oasrAccepted; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatRequired; // Set a reminder 15 minutes before office365.Events[0].IsReminderOn = true; office365.Events[0].ReminderMinutesBeforeStart = 15; office365.UpdateEvent(0);

Listing Events

Information about events fetched by the component can be accessed through the events properties. The events properties is populated when the list_events method is called.

By default, the component will fetch one page of 100 events when list_events is called. If additional events remain, the list_events_marker property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if list_events is then called again on the same calendar, if called the next page of events will be fetched. The example below populates the events properties with all the events associated with the specified calendar. do { office365.ListEvents(office365.Calendars[0].Id); } while (office365.ListEventsMarker.Length > 0);

Retrieving an Event

To retrieve an event use the get_event method and provide the Id of the event. The event is added to the end of the events collection.

Example (Retrieve an Event)

// Retrieve an event by its ID string eventId = "12345"; // Replace with the actual event ID gcal.GetEvent(eventId); // Access the retrieved event var retrievedEvent = office365.Events[office365.Events.Count - 1]; retrievedEvent.Subject; //event subject retrievedEvent.StartDateTime; //start dateTime of event retrievedEvent.AttendeeStatusResponse; //attendee status response gcal.GetEventField(gcal.Events.Count - 1, "/json/subject"); //event name gcal.GetEventField(gcal.Events.Count - 1, "/json/isCancelled"); //if the event is cancelled

Deleting an Event

To delete an event use the delete_event method, provide the Id of the event and the Id of the calendar as the argument. The event will stay in the events collection until list_events method is called again.

Example (Delete Events

// List events and delete the event named "new event name" office365.ListEvents(office365.Calendars[0].Id); for (int i = 0; i < office365.Events.Count; i++) { if (office365.Events[i].Subject == "new event name") { office365.DeleteEvent(office365.Calendars[0].Id, office365.Events[i].Id); break; } // Note: the component would let you name more than one event with the same name so the example would delete the first encounter with the event 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_event_id
• attachment_file_name
• attachment_id
• attachment_is_inline
• attachment_json
• attachment_last_modified_date
• attachment_name
• attachment_size

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_event_id Property

This property contains the event identifier of the attachment.

Syntax

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

Default Value

""

Remarks

This field contains the event 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_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_is_inline Property

This property is true if the attachment is an inline attachment.

Syntax

def get_attachment_is_inline(attachment_index: int) -> bool: ...
def set_attachment_is_inline(attachment_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

This field is true if the attachment is an inline 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_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.

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 = "offline_access user.read Calendars.Read Calendars.ReadWrite"; oauth.ClientProfile = OAuthClientProfiles.ocpApplication; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365calendar.Authorization = oauth.GetAuthorization();

calendars_count Property

The number of records in the Calendar arrays.

Syntax

def get_calendars_count() -> int: ...
def set_calendars_count(value: int) -> None: ...

calendars_count = property(get_calendars_count, set_calendars_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• calendar_can_edit
• calendar_can_share
• calendar_can_view_private_items
• calendar_change_key
• calendar_color
• calendar_hex_color
• calendar_id
• calendar_is_default_calendar
• calendar_is_removable
• calendar_name
• calendar_owner

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

calendar_can_edit Property

true if the user can write to the calendar, false otherwise.

Syntax

def get_calendar_can_edit(calendar_index: int) -> bool: ...

Default Value

FALSE

Remarks

true if the user can write to the calendar, false otherwise.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_can_share Property

true if the user has the permission to share the calendar, false otherwise.

Syntax

def get_calendar_can_share(calendar_index: int) -> bool: ...

Default Value

FALSE

Remarks

true if the user has the permission to share the calendar, false otherwise.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_can_view_private_items Property

true if the user can read calendar items that have been marked private, false otherwise.

Syntax

def get_calendar_can_view_private_items(calendar_index: int) -> bool: ...

Default Value

FALSE

Remarks

true if the user can read calendar items that have been marked private, false otherwise.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_change_key Property

Identifies the version of the calendar object.

Syntax

def get_calendar_change_key(calendar_index: int) -> str: ...

Default Value

""

Remarks

Identifies the version of the calendar object.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_color Property

Specifies the color theme to distinguish the calendar from other calendars in a UI.

Syntax

def get_calendar_color(calendar_index: int) -> int: ...
def set_calendar_color(calendar_index: int, value: int) -> None: ...

Default Value

0

Remarks

Specifies the color theme to distinguish the calendar from other calendars in a UI.

Possible values are:

• 0 (occAuto)
• 1 (occLightBlue)
• 2 (occLightGreen)
• 3 (occLightOrange)
• 4 (occLightGray)
• 5 (occLightYellow)
• 6 (occLightTeal)
• 7 (occLightPink)
• 8 (occLightBrown)
• 9 (occLightRed)
• 10 (occMaxColor)

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

calendar_hex_color Property

The calendar color, expressed in a hex color code.

Syntax

def get_calendar_hex_color(calendar_index: int) -> str: ...

Default Value

""

Remarks

The calendar color, expressed in a hex color code.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_id Property

The unique identifier of the calendar.

Syntax

def get_calendar_id(calendar_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of the calendar.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_is_default_calendar Property

True if this is the default calendar where new events are created by default, false otherwise.

Syntax

def get_calendar_is_default_calendar(calendar_index: int) -> bool: ...

Default Value

FALSE

Remarks

True if this is the default calendar where new events are created by default, false otherwise.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_is_removable Property

Indicates whether this user calendar can be deleted from the user mailbox.

Syntax

def get_calendar_is_removable(calendar_index: int) -> bool: ...

Default Value

FALSE

Remarks

Indicates whether this user calendar can be deleted from the user mailbox.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_name Property

the calendar's name.

Syntax

def get_calendar_name(calendar_index: int) -> str: ...
def set_calendar_name(calendar_index: int, value: str) -> None: ...

Default Value

""

Remarks

the calendar's name

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

calendar_owner Property

If set, this represents the user who created or added the calendar.

Syntax

def get_calendar_owner(calendar_index: int) -> str: ...

Default Value

""

Remarks

If set, this represents the user who created or added the calendar. For a calendar that the user created or added, the owner property is set to the user. For a calendar shared with the user, the owner property is set to the person who shared that calendar with the user.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

events_count Property

The number of records in the Event arrays.

Syntax

def get_events_count() -> int: ...
def set_events_count(value: int) -> None: ...

events_count = property(get_events_count, set_events_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• event_attendee_email
• event_attendee_index
• event_attendee_new_time_end
• event_attendee_new_time_end_time_zone
• event_attendee_new_time_start
• event_attendee_new_time_start_time_zone
• event_attendees_count
• event_attendee_status_response
• event_attendee_status_time
• event_attendee_type
• event_body
• event_body_is_html
• event_body_preview
• event_calendar_id
• event_categories
• event_change_key
• event_created_date_time
• event_end_date_time
• event_end_time_zone
• event_event_type
• event_has_attachments
• event_id
• event_importance
• event_is_all_day
• event_is_cancelled
• event_is_reminder_on
• event_json
• event_last_modified_date_time
• event_original_end_time_zone
• event_original_start_date_time
• event_original_start_time_zone
• event_recur_day_of_month
• event_recur_days_of_week
• event_recur_end_date
• event_recur_first_day_of_week
• event_recur_index
• event_recur_interval
• event_recur_month
• event_recur_number_of_occurrences
• event_recur_range_type
• event_recur_start_date
• event_recur_time_zone
• event_recur_type
• event_reminder_minutes_before_start
• event_sensitivity
• event_series_master_id
• event_show_as
• event_start_date_time
• event_start_time_zone
• event_subject

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

event_attendee_email Property

Attendee email address.

Syntax

def get_event_attendee_email(event_index: int) -> str: ...
def set_event_attendee_email(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

Attendee email address. Set to empty string or null to delete.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_index Property

Index of attendee to get or set its properties.

Syntax

def get_event_attendee_index(event_index: int) -> int: ...
def set_event_attendee_index(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

Index of attendee to get or set its fields.

Example OCalEvent currentEvent = ocal.Events[0]; //retrieve event after creation //Set properties to update currentEvent.Subject = "Birthday party"; currentEvent.AttendeesCount = 2; //this event will have 2 attendees //Set the attendee properties for both attendees currentEvent.AttendeeIndex = 0; //set index of attendee currentEvent.AttendeeEmail = "example@example.com"; currentEvent.AttendeeIndex = 1; //set index of attendee currentEvent.AttendeeEmail = "example2@example.com";

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_new_time_end Property

Attendee's proposed new event ending time.

Syntax

def get_event_attendee_new_time_end(event_index: int) -> str: ...

Default Value

""

Remarks

Attendee's proposed new event ending time.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_attendee_new_time_end_time_zone Property

The end time zone that was proposed by attendee.

Syntax

def get_event_attendee_new_time_end_time_zone(event_index: int) -> str: ...

Default Value

""

Remarks

The end time zone that was proposed by attendee. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_attendee_new_time_start Property

Attendee's new event starting time.

Syntax

def get_event_attendee_new_time_start(event_index: int) -> str: ...

Default Value

""

Remarks

Attendee's new event starting time.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_attendee_new_time_start_time_zone Property

The start time zone that was proposed by attendee.

Syntax

def get_event_attendee_new_time_start_time_zone(event_index: int) -> str: ...

Default Value

""

Remarks

The start time zone that was proposed by attendee. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_attendees_count Property

When retrieving events, it indicates the number of attendees linked to the event.

Syntax

def get_event_attendees_count(event_index: int) -> int: ...
def set_event_attendees_count(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

When retrieving events, it indicates the number of attendees linked to the event. When updating an event, this property is set to the number of attendees the event will have.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_status_response Property

The attendee's response status.

Syntax

def get_event_attendee_status_response(event_index: int) -> int: ...
def set_event_attendee_status_response(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

The attendee's response status.

Possible values are:

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_status_time Property

The date and time when the response was returned.

Syntax

def get_event_attendee_status_time(event_index: int) -> str: ...
def set_event_attendee_status_time(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

The date and time when the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_type Property

The attendee type.

Syntax

def get_event_attendee_type(event_index: int) -> int: ...
def set_event_attendee_type(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

The attendee type.

Possible values are:

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_body Property

The body of the message associated with the event.

Syntax

def get_event_body(event_index: int) -> str: ...
def set_event_body(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

The body of the message associated with the event. It can be in HTML or text format.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_body_is_html Property

Indicates the text format of the body is HTML.

Syntax

def get_event_body_is_html(event_index: int) -> bool: ...
def set_event_body_is_html(event_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Indicates the text format of the body is HTML.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_body_preview Property

The preview of the message associated with the event.

Syntax

def get_event_body_preview(event_index: int) -> str: ...
def set_event_body_preview(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

The preview of the message associated with the event. It is in text format.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_calendar_id Property

The ID of the calendar that contains the event.

Syntax

def get_event_calendar_id(event_index: int) -> str: ...

Default Value

""

Remarks

The ID of the calendar that contains the event.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_categories Property

The categories associated with the event.

Syntax

def get_event_categories(event_index: int) -> str: ...
def set_event_categories(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_change_key Property

Identifies the version of the event object.

Syntax

def get_event_change_key(event_index: int) -> str: ...

Default Value

""

Remarks

Identifies the version of the event object.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_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_event_created_date_time(event_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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_end_date_time Property

The date, time, and time zone that the event ends.

Syntax

def get_event_end_date_time(event_index: int) -> str: ...
def set_event_end_date_time(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

The date, time, and time zone that the event ends. By default, the end time is in UTC.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_end_time_zone Property

The current end time zone.

Syntax

def get_event_end_time_zone(event_index: int) -> str: ...
def set_event_end_time_zone(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

The current end time zone. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_event_type Property

The event type.

Syntax

def get_event_event_type(event_index: int) -> int: ...

Default Value

0

Remarks

The event type.

Possible values are:

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_has_attachments Property

Set to true if the event has attachments.

Syntax

def get_event_has_attachments(event_index: int) -> bool: ...

Default Value

FALSE

Remarks

Set to true if the event has attachments.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_id Property

The unique identifier of the event.

Syntax

def get_event_id(event_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of the event.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_importance Property

The importance of the event.

Syntax

def get_event_importance(event_index: int) -> int: ...
def set_event_importance(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

The importance of the event.

Possible values are:

• 0 (ociLow)
• 1 (ociNormal)
• 2 (ociHigh)

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_is_all_day Property

Set to true if the event lasts all day.

Syntax

def get_event_is_all_day(event_index: int) -> bool: ...
def set_event_is_all_day(event_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Set to true if the event lasts all day. Setting Start and End is required when changing this value.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_is_cancelled Property

Set to true if the event has been canceled.

Syntax

def get_event_is_cancelled(event_index: int) -> bool: ...

Default Value

FALSE

Remarks

Set to true if the event has been canceled.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_is_reminder_on Property

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

Syntax

def get_event_is_reminder_on(event_index: int) -> bool: ...
def set_event_is_reminder_on(event_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_json Property

A JSON representation of the event.

Syntax

def get_event_json(event_index: int) -> str: ...
def set_event_json(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_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_event_last_modified_date_time(event_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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_original_end_time_zone Property

The end time zone that was set when the event was created.

Syntax

def get_event_original_end_time_zone(event_index: int) -> str: ...

Default Value

""

Remarks

The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_original_start_date_time Property

Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series.

Syntax

def get_event_original_start_date_time(event_index: int) -> str: ...

Default Value

""

Remarks

Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_original_start_time_zone Property

The start time zone that was set when the event was created.

Syntax

def get_event_original_start_time_zone(event_index: int) -> str: ...

Default Value

""

Remarks

The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_recur_day_of_month Property

The day of the month on which the event occurs.

Syntax

def get_event_recur_day_of_month(event_index: int) -> int: ...
def set_event_recur_day_of_month(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recur_days_of_week Property

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

Syntax

def get_event_recur_days_of_week(event_index: int) -> str: ...
def set_event_recur_days_of_week(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

A space separated collection of the days of the week on which the event 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 event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recur_end_date Property

The date to stop applying the recurrence pattern.

Syntax

def get_event_recur_end_date(event_index: int) -> str: ...
def set_event_recur_end_date(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recur_first_day_of_week Property

The first day of the week.

Syntax

def get_event_recur_first_day_of_week(event_index: int) -> str: ...
def set_event_recur_first_day_of_week(event_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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recur_index Property

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

Syntax

def get_event_recur_index(event_index: int) -> str: ...
def set_event_recur_index(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

Specifies on which instance of the allowed days specified in daysOfWeek the event 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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_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_event_recur_interval(event_index: int) -> int: ...
def set_event_recur_interval(event_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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recur_month Property

The month in which the event occurs.

Syntax

def get_event_recur_month(event_index: int) -> int: ...
def set_event_recur_month(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recur_number_of_occurrences Property

The number of times to repeat the event.

Syntax

def get_event_recur_number_of_occurrences(event_index: int) -> int: ...
def set_event_recur_number_of_occurrences(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recur_range_type Property

The recurrence range.

Syntax

def get_event_recur_range_type(event_index: int) -> int: ...
def set_event_recur_range_type(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

The recurrence range.

Possible values are:

• 0 (ocrrtEndDate)
• 1 (ocrrtNoEnd)
• 2 (ocrrtNumbered)

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recur_start_date Property

The date to start applying the recurrence pattern.

Syntax

def get_event_recur_start_date(event_index: int) -> str: ...
def set_event_recur_start_date(event_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 event. Must be the same value as the start property of the recurring event. Required.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recur_time_zone Property

Time zone for the startDate and endDate properties.

Syntax

def get_event_recur_time_zone(event_index: int) -> str: ...
def set_event_recur_time_zone(event_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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recur_type Property

The recurrence pattern type Possible values are: 0 (ocrtDaily) 1 (ocrtWeekly) 2 (ocrtAbsoluteMonthly) 3 (ocrtRelativeMonthly) 4 (ocrtAbsoluteYearly) 5 (ocrtRelativeYearly) .

Syntax

def get_event_recur_type(event_index: int) -> int: ...
def set_event_recur_type(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

The recurrence pattern type

Possible values are:

• 0 (ocrtDaily)
• 1 (ocrtWeekly)
• 2 (ocrtAbsoluteMonthly)
• 3 (ocrtRelativeMonthly)
• 4 (ocrtAbsoluteYearly)
• 5 (ocrtRelativeYearly)

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_reminder_minutes_before_start Property

The number of minutes before the event start time that the reminder alert occurs.

Syntax

def get_event_reminder_minutes_before_start(event_index: int) -> int: ...
def set_event_reminder_minutes_before_start(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

The number of minutes before the event start time that the reminder alert occurs.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_sensitivity Property

The event sensitivity Possible values are: 0 (ocsNormal) 1 (ocsPersonal) 2 (ocsPrivate) 3 (ocsConfidential) .

Syntax

def get_event_sensitivity(event_index: int) -> int: ...
def set_event_sensitivity(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

The event sensitivity

Possible values are:

• 0 (ocsNormal)
• 1 (ocsPersonal)
• 2 (ocsPrivate)
• 3 (ocsConfidential)

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_series_master_id Property

The ID for the recurring series master item, if this event is part of a recurring series.

Syntax

def get_event_series_master_id(event_index: int) -> str: ...

Default Value

""

Remarks

The ID for the recurring series master item, if this event is part of a recurring series.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_show_as Property

The status to show.

Syntax

def get_event_show_as(event_index: int) -> int: ...
def set_event_show_as(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

The status to show.

Possible values are:

• 0 (ocsaFree)
• 1 (ocsaTentative)
• 2 (ocsaBusy)
• 3 (ocsaOOF)
• 4 (ocsaWorkingElsewhere)
• 5 (ocsaUnknown)

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_start_date_time Property

The start date, time, and time zone of the event.

Syntax

def get_event_start_date_time(event_index: int) -> str: ...
def set_event_start_date_time(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

The start date, time, and time zone of the event. By default, the start time is in UTC.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_start_time_zone Property

The current start time zone.

Syntax

def get_event_start_time_zone(event_index: int) -> str: ...
def set_event_start_time_zone(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

The current start time zone. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_subject Property

The text of the event's subject line.

Syntax

def get_event_subject(event_index: int) -> str: ...
def set_event_subject(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

The text of the event's subject line.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

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_events_marker Property

The page marker for listing events.

Syntax

def get_list_events_marker() -> str: ...
def set_list_events_marker(value: str) -> None: ...

list_events_marker = property(get_list_events_marker, set_list_events_marker)

Default Value

""

Remarks

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

Example (List All Events in a Calendar):

do { office365.ListEvents(calendarId); } while (office365.ListEventsMarker.Length > 0);

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.

add_attachment Method

Adds a file attachment to an existing event.

Syntax

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

Remarks

This method adds a file attachment to an existing event, specified by the EventId 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. Note that this operation will not clear the attachments properties.

If the file size exceeds the value set in the AttachmentSimpleUploadLimit configuration, the class will use an upload session to upload the attachment in fragments. The size of these fragments is specified in the AttachmentFragmentSize configuration. You can also set the LocalFile as an empty string, in which case the data will be read from the input stream set beforehand using set_attachment_in_stream().

Example (Adding a Simple Attachment to a New Event)

office365.CreateEvent("Event Subject", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", calendarId); string eventId = office365.Events[0].Id; office365.AddAttachment(eventId, "file1.zip", "./file1.zip"); Example (Adding a Complex Attachment to a New Event) Example (Uploading an Attachment in Fragments)

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_calendar Method

Creates a new calendar.

Syntax

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

Remarks

Creates a new calendar identified by the Name parameter, the display name of the calendar to be created. If a calendar with the same name already exists, the class will not overwrite it and will return an error indicating conflict.

The newly created calendar is added at the beginning of the calendars properties.

If you need to specify more properties or customize the calendar beyond the basic creation, first create the calendar and then update it using the update_calendar method.

Example (Creating a New Calendar)

office365.CreateCalendar(name); string statusLine = office365.Config("StatusLine")); // It should be "HTTP/1.1 201 Created"

create_event Method

Creates an event. The timezone is UTC.

Syntax

def create_event(subject: str, start_time: str, end_time: str, calendar_id: str) -> None: ...

Remarks

Creates a new event with the specified details. The Subject parameter defines the title or description of the event, while the StartTime and EndTime parameters specify the start and end times of the event in UTC. Both the StartTime and EndTime times should be in the format yyyy-MM-ddTHH:mm:ss. The CalendarId parameter identifies the calendar in which the event will be created. If CalendarId is set to "" the event will be added in the default Calendar.

Attachments can also be added to the event using the add_attachment method. For more details on how to add attachments, refer to the add_attachment method.

If you need to set additional properties or customize the event further, use the update_event method after creation to modify attributes like location, attendees, reminders etc.

Example(Create a New event) office365.ListCalendars(); office365.CreateEvent("TestSub", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", office365.Calendars[index].Id);

delete_attachment Method

Deletes an attachment.

Syntax

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

Remarks

Deletes an attachment from an event using the id parameter to identify the event and the attachmentId to identify the attachment to be removed. However, this operation does not delete the attachment from the attachments properties.

Example(Delete an Attachment)

office365.DeleteAttachment(eventId, attachmentId);

delete_calendar Method

Deletes a calendar.

Syntax

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

Remarks

Deletes a calendar identified by the id parameter. The calendar and all its associated events will be removed, and this operation will also delete the calendar from the calendars properties.

delete_event Method

Deletes an event.

Syntax

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

Remarks

Deletes an event identified by the id parameter. The specified event will be permanently removed and any attachments associated with it. This method also deletes the event from the events properties.

get_calendar_view Method

Lists the events as calendar view.

Syntax

def get_calendar_view(calendar_id: str, start_time: str, end_time: str) -> None: ...

Remarks

Retrieves a list of events within a specified time range, displaying them in a calendar view format. The calendarId parameter identifies the calendar from which to list the events; , if left empty, the events will be listed from the default Calendar. The StartTime and EndTime parameters define the time range for the events to be retrieved and should be in the format yyyy-MM-ddTHH:mm:ss. If you do not want to specify the start and end times, you can use the list_events method, which retrieves events without time range constraints.

get_event Method

Retrieves the event by Id.

Syntax

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

Remarks

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

Example (Get an Event)

// Retrieve an event by its ID office365.GetEvent(eventId); // Access the retrieved event OCalEvent event = office365.Events[0]; event.Subject; //event subject/title event.StartTime; event.EndTime; for(int i = 0; i < event.AttendeesCount; i++){ event.AttendeeIndex = i; event.AttendeeEmail; // the email of the attendee event.AttendeeStatusResponse; // the response of the attendee event.Body; // the body of the event }

get_event_field Method

Retrieves the event property value by JSONPath.

Syntax

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

Remarks

This method retrieves a specific field within the event's JSON field. The first parameter, index, represents the index of the event in the events 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. For a full list of the fields an event has/can have, please refer to the official documentation of the Office365 Calendars API documentation.

Example (Access Fields of an Event)

office365.GetEvent(eventId); office365.GetEventField(0, "/json/hasAttachments"); // Set to true if the event has attachments. office365.GetEventField(0, "/json/end/dateTime"); // The date and time that the event ends. office365.GetEventField(0, "/json/location/displayName"); // The name associated with the location. office365.GetEventField(0, "/json/location/address/city"); // The city associated with the location.

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 event's attachments.

Syntax

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

Remarks

This method lists all of a event's attachments. This method clears and populates the attachments properties. No content data returns in this case

Lists all attachments of the specified event identified by the id parameter, clearing and updating the attachments properties with the retrieved attachments. For each attachment found, the on_attachment_list event is fired. Content data of the attachments is not included in the response; to access the actual content of an attachment, use the retrieve_attachment method.

Example(List Attachments of an Event) office365.ListAttachments(eventId); foreach(OCalAttachment attachment in office365.Attachments){ attachment.Id; attachment.FileName; attachment.Name; attachment.ContentType; attachment.Data; // Data is NOT accessible only by calling ListAttachments. }

list_calendars Method

Lists the calendars.

Syntax

def list_calendars() -> None: ...

Remarks

Lists all calendars associated with the current user. The retrieved calendars are added to the calendars properties, which is cleared before being repopulated with the latest data. For each calendar retrieved, the on_calendar_list event is fired.

list_events Method

Lists the events.

Syntax

def list_events(calendar_id: str) -> None: ...

Remarks

Retrieves a list of events from the specified calendar identified by the calendarId parameter, if this parameter is left empty, the events will be retrieved from the default calendar. The retrieved events are added to the events properties, which is cleared before being repopulated with the latest events data. For each event retrieved, the on_event_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 an event attachment.

Syntax

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

Remarks

Retrieves the data of a specific attachment from an event. The id parameter identifies the event, and the attachmentId specifies the attachment to be fetched. Upon retrieval, the attachment's content data is returned, making it accessible for further use.

The fetched attachment can be accessed through the Attachment* properties, which holds the details of all retrieved attachments.

Example(Retrieve an Attachment of an Event) office365.RetrieveAttachment(id); office365.Attachments[0].Id; office365.Attachments[0].FileName; office365.Attachments[0].Name; office365.Attachments[0].ContentType; office365.Attachments[0].Data; }

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.

Example (Send a custom request):

String data = @"{ ""name"": ""My Calendar"", ""color"": ""auto"", ""isDefaultCalendar"": false, ""canShare"": true, ""canEdit"": true, ""isRemovable"": true, }"; String url = "https://graph.microsoft.com/v1.0/me/calendars"; office365.SendCustomRequest("POST", url, data);

set_event_field Method

Sets the event field value by JSONPath.

Syntax

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

Remarks

This method is used to update a specific field within the event's JSON representation. Once the method is used, update_event needs to be called for the update to take effect. The parameters for this method are as follows: the first parameter, index, represents the index of the event in the events 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 an Event before Updating): // Create an event. office365.CreateEvent("Subject", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", calendarId); office365.SetEventField(0, "/json/categories", "[\"category1\", \"category2\"]", 1); office365.SetEventField(0, "/json/end", "{\"dateTime\": \"yyyy-MM-ddTHH:mm:ss\", \"timeZone\": \"UTC\"}", 0); // Update the event office365.UpdateEvent(0);

For a full list of the fields an event has/can have, please refer to the official documentation of the Office365 Calendars API documentation.

update_calendar Method

Updates a calendar.

Syntax

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

Remarks

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

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

The OCalCalendar type used in the calendars collection includes the fields of a calendar. Refer to the OCalCalendar type for a complete list of fields.

Example: office365.CreateCalendar(name); // Fields to update office365.Calendars[0].Name = newName; office365.Calendars[0].Color = color; // Update the calendar office365.UpdateCalendar(0);

update_event Method

Updates an event.

Syntax

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

Remarks

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

To update an event, edit the desired event fields within the events collection. Then, call the update_event method with the index of the event. Note that changing the JSON data will overwrite the entire event, ignoring other field edits made before setting the JSON.

The OCalEvent type used in the events collection includes the fields of an event. Refer to the OCalEvent type for a complete list of fields. If you need to add other fields, you can use the set_event_field method. For a complete list of fields an event can have, please refer to the Microsoft Graph API documentation.

Example: office365.ListCalendars(); // Create the event office365.CreateEvent("TestSub", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", office365.Calendars[index].Id); office365.Events[0].Subject = "New Test Subject"; office365.Events[0].Importance = TOCImportances.ociHigh; office365.Events[0].AttendeesCount = 2; office365.Events[0].AttendeeIndex = 0; office365.Events[0].AttendeeEmail = email1; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatRequired; office365.Events[0].AttendeeIndex = 1; office365.Events[0].AttendeeEmail = email2; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatOptional; office365.Events[0].Body = "weekly meeting"; //update the event office365.UpdateEvent(0);

on_attachment_list Event

Fired when an attachment is retrieved from the server.

Syntax

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

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

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

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

  @property
  def is_inline() -> bool: ...

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

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

Remarks

The on_attachment_list event is fired for each attachment retrieved from the server when list_attachments is called.

on_calendar_list Event

Fired when a calendar is retrieved from the server.

Syntax

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

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

# In class Office365Calendars:
@property
def on_calendar_list() -> Callable[[Office365CalendarsCalendarListEventParams], None]: ...
@on_calendar_list.setter
def on_calendar_list(event_hook: Callable[[Office365CalendarsCalendarListEventParams], None]) -> None: ...

Remarks

The on_calendar_list event is fired for each calendar retrieved from the server when list_calendars is called.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

# In class Office365Calendars:
@property
def on_error() -> Callable[[Office365CalendarsErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[Office365CalendarsErrorEventParams], 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_event_list Event

Fired when an event is retrieved from the server.

Syntax

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

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

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

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

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

# In class Office365Calendars:
@property
def on_event_list() -> Callable[[Office365CalendarsEventListEventParams], None]: ...
@on_event_list.setter
def on_event_list(event_hook: Callable[[Office365CalendarsEventListEventParams], None]) -> None: ...

Remarks

The on_event_list event is fired for each event retrieved from the server when list_events is called. This event provides details about each event, including its Id, the CalendarId it belongs to, the Subject (title or description), and the StartTime and EndTime times.

on_log Event

Fired once for each log message.

Syntax

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

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

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

# In class Office365Calendars:
@property
def on_log() -> Callable[[Office365CalendarsLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[Office365CalendarsLogEventParams], 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 Office365CalendarsSSLServerAuthenticationEventParams(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 Office365Calendars:
@property
def on_ssl_server_authentication() -> Callable[[Office365CalendarsSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[Office365CalendarsSSLServerAuthenticationEventParams], 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 Office365CalendarsSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

on_transfer Event

Fired while a document transfers (delivers document).

Syntax

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

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

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

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

# In class Office365Calendars:
@property
def on_transfer() -> Callable[[Office365CalendarsTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[Office365CalendarsTransferEventParams], 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.

Office365Calendars Config Settings

Office365Calendars 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