Box Class

Properties   Methods   Events   Config Settings   Errors  

The Box class makes it easy to upload, download, and manage files and folders within Box.com.

Syntax

class cloudstorage.Box

Remarks

The Box class provides a simple interface to working with Box.com. Capabilities include uploading and downloading files, strong encryption support, creating folders, moving and copying resources, and more.

Authentication

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:

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: Box box = new Box(); box.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; box.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; box.OAuth.ClientId = CLIENT_ID; box.OAuth.ClientSecret = CLIENT_SECRET; box.Config("OAuthWebServerPort=PORT"); // http://localhost:PORT needs to be a registered redirect URL for the app box.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.

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.GrantType = OauthGrantTypes.ogtAuthorizationCode; oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://app.box.com/api/oauth2/authorize"; oauth.ServerTokenURL = "https://api.box.com/oauth2/token"; oauth.WebServerPort = PORT; // http://localhost:PORT needs to be a registered redirect URL for the app box.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Listing Resources

list_resources lists resources within the specified folder. Calling this method will fire the on_resource_list event once for each resource, and will also populate the resources properties.

If there are still more resources available to list when this method returns, the resource_marker property will be populated. Continue to call this method until resource_marker is empty to accumulate all pages of results in the resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the resources properties every time a page of results is returned. // ResourceList event handler. box.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; do { box.ListResources("d:123456"); for (int i = 0; i < box.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(box.ResourceMarker));

Downloading Files

The download_file method downloads file resources.

If local_file is set, the file will be saved to the specified location; otherwise, the file data will be held by resource_data.

To download and decrypt an encrypted file, set encryption_algorithm and encryption_password before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: box.LocalFile = "../MyFile.zip"; box.DownloadFile(box.Resources[0].Id);

Resuming Downloads

The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; box.LocalFile = downloadFile; box.DownloadFile(box.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file box.StartByte = new FileInfo(downloadFile).Length; box.DownloadFile(box.Resources[0].Id);

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file. box.LocalFile = "../MyFile.zip"; box.EncryptionPassword = "password"; box.DownloadFile(box.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file box.StartByte = new FileInfo(box.Config("DownloadTempFile")).Length; box.DownloadFile(box.Resources[0].Id);

Uploading Files

The upload_file method uploads new file resources.

If local_file is set the file will be uploaded from the specified path. If local_file is not set the data in resource_data will be used.

To encrypt the file before uploading it, set encryption_algorithm and encryption_password.

Upload Notes

Box offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files (must be larger than 20 MB), uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. When doing a simple upload, the HashSimpleUploads setting is applicable. box.LocalFile = "../MyFile.zip"; box.UploadFile("MyFile.zip", "");

Resumable

To enable resumable uploads set use_resumable_upload to True. This is recommended for large files (must be larger than 20 MB). The class will automatically fragment the specified file into smaller pieces and upload each individually.

When use_resumable_upload is set to True and upload_file is called, a resumable upload session is started by the class. resume_url is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the on_fragment_complete event fires after each fragment is uploaded to indicate overall progress. The class also updates start_byte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that resume_url is populated (if the same instance of the class is used, it should already be populated, and no special action should be needed). Call poll_upload_status to populate the correct values for start_byte and UploadFragmentSize. Then call upload_file again to resume the upload at the specified start_byte offset.

Note that if the upload is not resumed after some time the upload session will expire. poll_upload_status may be used to check the status of a resumable upload, including when it will expire (which is stored in the UploadExpDate configuration setting). An interrupted upload can be aborted explicitly using the abort_upload method. box.LocalFile = "../MyFile.zip"; box.UploadFile("MyFile.zip", ""); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. box.UploadFile("MyFile.zip", "");

Additional Functionality

The Box class offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using the encryption_algorithm and encryption_password properties.
• Basic file and folder manipulation and organization using methods such as copy_resource, create_folder, delete_resource, move_resource, and restore_resource.
• Support for resource sharing using create_link and revoke_link.
• Resource metadata management with create_metadata, list_metadata, update_metadata, and delete_metadata.
• Advanced resource listing using the search method.
• Retrieval of account and space usage details using get_account_info.
• File version handling with list_versions and promote_version.
• And more!

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.

account_address Property

The address of the account's user.

Syntax

def get_account_address() -> str: ...

account_address = property(get_account_address, None)

Default Value

""

Remarks

The address of the account's user.

This property reflects the address of the account's user.

This property is read-only.

account_created_time Property

The creation timestamp of the account.

Syntax

def get_account_created_time() -> str: ...

account_created_time = property(get_account_created_time, None)

Default Value

""

Remarks

The creation timestamp of the account.

This property reflects the creation timestamp of the account. Timestamps are formatted according to RFC 3339.

This property is read-only.

account_email Property

The email address of the account.

Syntax

def get_account_email() -> str: ...

account_email = property(get_account_email, None)

Default Value

""

Remarks

The email address of the account.

This property reflects the email address associated with the account.

This property is read-only.

account_enterprise_id Property

The Id of the enterprise the account is a member of.

Syntax

def get_account_enterprise_id() -> str: ...

account_enterprise_id = property(get_account_enterprise_id, None)

Default Value

""

Remarks

The Id of the enterprise the account is a member of.

This property reflects the Id of the enterprise that the account is a member of. It will be empty if the account isn't part of an enterprise.

This property is read-only.

account_id Property

The Id of the account.

Syntax

def get_account_id() -> str: ...

account_id = property(get_account_id, None)

Default Value

""

Remarks

The Id of the account.

This property reflects the Id of the account.

This property is read-only.

account_modified_time Property

The last modified timestamp of the account.

Syntax

def get_account_modified_time() -> str: ...

account_modified_time = property(get_account_modified_time, None)

Default Value

""

Remarks

The last modified timestamp of the account.

This property reflects the last modified timestamp of the account. Timestamps are formatted according to RFC 3339.

This property is read-only.

account_name Property

The name of the account's user.

Syntax

def get_account_name() -> str: ...

account_name = property(get_account_name, None)

Default Value

""

Remarks

The name of the account's user.

This property reflects the name of the account's user.

This property is read-only.

account_phone Property

The phone number of the account's user.

Syntax

def get_account_phone() -> str: ...

account_phone = property(get_account_phone, None)

Default Value

""

Remarks

The phone number of the account's user.

This property reflects the phone number of the account's user.

This property is read-only.

account_role Property

The account's role.

Syntax

def get_account_role() -> int: ...

account_role = property(get_account_role, None)

Default Value

0

Remarks

The account's role.

This property reflects the account's role. Possible values are:

• 0 (arUser)
• 1 (arCoadmin)
• 2 (arAdmin)

This property is read-only.

account_status Property

The account's status.

Syntax

def get_account_status() -> int: ...

account_status = property(get_account_status, None)

Default Value

0

Remarks

The account's status.

This property reflects the account's status. Possible values are:

• 0 (asActive)
• 1 (asInactive)
• 2 (asNoDeleteOrEdit)
• 3 (asNoDeleteEditOrUpload)

This property is read-only.

account_tags Property

The account's resource tags.

Syntax

def get_account_tags() -> str: ...

account_tags = property(get_account_tags, None)

Default Value

""

Remarks

The account's resource tags.

This property holds a comma-separated list containing all of the tags that the account has applied to any of its resources.

This property is read-only.

account_total_space Property

The total amount of space allocated to the account.

Syntax

def get_account_total_space() -> int: ...

account_total_space = property(get_account_total_space, None)

Default Value

-1

Remarks

The total amount of space allocated to the account.

This property reflects the total amount of space, in bytes, allocated to the account.

This property is read-only.

account_used_space Property

The amount of space used by the account.

Syntax

def get_account_used_space() -> int: ...

account_used_space = property(get_account_used_space, None)

Default Value

-1

Remarks

The amount of space used by the account.

This property reflects the amount of space, in bytes, used by the account.

This property is read-only.

authorization Property

OAuth 2.0 Authorization Token.

Syntax

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

authorization = property(get_authorization, set_authorization)

Default Value

""

Remarks

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property, using the OAuth class or a separate process. If using the o_auth property, then the authorization property will not be used.

Bearer ACCESS_TOKEN

download_type Property

The download type to use for file resources.

Syntax

def get_download_type() -> int: ...
def set_download_type(value: int) -> None: ...

download_type = property(get_download_type, set_download_type)

Default Value

0

Remarks

This property controls what the class will download when download_file is called for a file resource. Possible values are:

File thumbnails may be customized using the ThumbnailFormat and ThumbnailSize configuration settings. Box returns placeholder thumbnail graphics for file types it cannot generate real thumbnails for.

If Box is still in the process of generating the requested thumbnail when this method is called, the class will populate the RetryAfter configuration setting and throw an exception. Retry the request after the number of seconds indicated by RetryAfter.

encryption_algorithm Property

The encryption algorithm.

Syntax

def get_encryption_algorithm() -> int: ...
def set_encryption_algorithm(value: int) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

encryption_password Property

The encryption password.

Syntax

def get_encryption_password() -> str: ...
def set_encryption_password(value: str) -> None: ...

encryption_password = property(get_encryption_password, set_encryption_password)

Default Value

""

Remarks

If this property is populated when upload_file or download_file is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

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.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

local_file Property

The location of the local file.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling upload_file or update_resource, and as the destination file when calling download_file.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: local_host is not persistent. You must always set it in code, and never in the property window.

metadata_count Property

The number of records in the Metadata arrays.

Syntax

def get_metadata_count() -> int: ...
def set_metadata_count(value: int) -> None: ...

metadata_count = property(get_metadata_count, set_metadata_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• metadata_container_schema
• metadata_container_scope
• metadata_mod_op
• metadata_name
• metadata_resource_id
• metadata_source_name
• metadata_value
• metadata_value_type

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

metadata_container_schema Property

The schema of the metadata item's container.

Syntax

def get_metadata_container_schema(metadata_index: int) -> str: ...
def set_metadata_container_schema(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The schema of the metadata item's container.

This property specifies the metadata of the schema item's container.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_container_scope Property

The scope that the metadata item's container resides in.

Syntax

def get_metadata_container_scope(metadata_index: int) -> str: ...
def set_metadata_container_scope(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The scope that the metadata item's container resides in.

This property specifies the scope that the metadata item's container resides in.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_mod_op Property

The modification operation to perform on the metadata item.

Syntax

def get_metadata_mod_op(metadata_index: int) -> int: ...
def set_metadata_mod_op(metadata_index: int, value: int) -> None: ...

Default Value

0

Remarks

The modification operation to perform on the metadata item.

This property specifies which modification operation should be performed for the metadata item when update_metadata is called. Possible values are:

Refer to update_metadata for more information.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_name Property

The name of the metadata item.

Syntax

def get_metadata_name(metadata_index: int) -> str: ...
def set_metadata_name(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the metadata item.

This property specifies the name of the metadata item. It cannot begin with the $ character.

This property may be used as input when create_metadata or update_metadata is called.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_resource_id Property

The Id of the resource the metadata item is associated with.

Syntax

def get_metadata_resource_id(metadata_index: int) -> str: ...
def set_metadata_resource_id(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The Id of the resource the metadata item is associated with.

This property specifies the Id of the resource the metadata item is associated with.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_source_name Property

The name of another metadata item from which to copy or move a value.

Syntax

def get_metadata_source_name(metadata_index: int) -> str: ...
def set_metadata_source_name(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of another metadata item from which to copy or move a value.

This property specifies the name of another metadata item whose value should be copied or moved to this one. It cannot begin with the $ character.

This property may be used as input when update_metadata is called if the metadata_mod_op property is set to one of the following:

• 3 (opCopyFrom)
• 4 (opMoveFrom)

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_value Property

The value of the metadata item.

Syntax

def get_metadata_value(metadata_index: int) -> str: ...
def set_metadata_value(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the metadata item.

This property specifies the value of the metadata item.

This property may be used as input when create_metadata or update_metadata is called if the metadata_mod_op property is set to one of the following:

• 1 (opAdd)
• 2 (opReplace)
• 6 (opTest)

When this property's value is sent to the server, it is encoded according to the metadata_value_type property.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_value_type Property

The type of the metadata item's value.

Syntax

def get_metadata_value_type(metadata_index: int) -> int: ...
def set_metadata_value_type(metadata_index: int, value: int) -> None: ...

Default Value

0

Remarks

The type of the metadata item's value.

This property specifies the type of the metadata item's value, and controls how the class encodes metadata_value when submitting it to the server. Possible values, and their corresponding Box types, are:

The metadata_value property should hold a comma-separated list of strings when this property is set to 2 (mtMultiSelect).

This property may be used as input when create_metadata or update_metadata is called if the metadata_mod_op property is set to one of the following:

• 1 (opAdd)
• 2 (opReplace)
• 6 (opTest)

Important: Box only allows string-typed metadata items in the /global/properties metadata container; the class will always ignore this property and encode metadata items as strings when creating or updating the /global/properties container.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

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.

other_headers Property

Other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

overwrite Property

Determines if local files are overwritten.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property controls whether local files are overwritten when calling download_file. It is only applicable to local files. The default value is False.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

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

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

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.

query_param_count Property

The number of records in the QueryParam arrays.

Syntax

def get_query_param_count() -> int: ...
def set_query_param_count(value: int) -> None: ...

query_param_count = property(get_query_param_count, set_query_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• query_param_name
• query_param_value

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

query_param_name Property

The name of the query parameter.

Syntax

def get_query_param_name(query_param_index: int) -> str: ...
def set_query_param_name(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

query_param_value Property

The value of the query parameter.

Syntax

def get_query_param_value(query_param_index: int) -> str: ...
def set_query_param_value(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

resource_data Property

The data that was downloaded, or that should be uploaded.

Syntax

def get_resource_data() -> bytes: ...
def set_resource_data(value: bytes) -> None: ...

resource_data = property(get_resource_data, set_resource_data)

Default Value

""

Remarks

This property is populated with file data after calling download_file if local_file is not set.

This property can also be set before calling upload_file; its data will be uploaded if local_file is not set.

resource_marker Property

A marker indicating what page of resources to return next.

Syntax

def get_resource_marker() -> str: ...
def set_resource_marker(value: str) -> None: ...

resource_marker = property(get_resource_marker, set_resource_marker)

Default Value

""

Remarks

This property will be populated when list_resources is called if the results are paged and there are more pages. To list all resources, continue to call list_resources until this property returns empty string.

Refer to list_resources for more information.

resource_count Property

The number of records in the Resource arrays.

Syntax

def get_resource_count() -> int: ...
def set_resource_count(value: int) -> None: ...

resource_count = property(get_resource_count, set_resource_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• resource_created_by
• resource_created_time
• resource_description
• resource_e_tag
• resource_hash
• resource_id
• resource_modified_by
• resource_modified_time
• resource_name
• resource_owner
• resource_parent_id
• resource_shared_link
• resource_shared_link_access
• resource_shared_link_protected
• resource_size
• resource_sync_state
• resource_tags
• resource_trashed
• resource_trashed_time
• resource_type
• resource_version_id

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

resource_created_by Property

The email address of the user who created the resource.

Syntax

def get_resource_created_by(resource_index: int) -> str: ...

Default Value

""

Remarks

The email address of the user who created the resource.

This property reflects the email address of the user who created the resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_created_time Property

The creation timestamp of the resource.

Syntax

def get_resource_created_time(resource_index: int) -> str: ...

Default Value

""

Remarks

The creation timestamp of the resource.

This property reflects the creation timestamp of the resource. Timestamps are formatted according to RFC 3339.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_description Property

A description of the resource.

Syntax

def get_resource_description(resource_index: int) -> str: ...
def set_resource_description(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

A description of the resource.

This property specifies a description of the resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_e_tag Property

The ETag of the resource.

Syntax

def get_resource_e_tag(resource_index: int) -> str: ...

Default Value

""

Remarks

The ETag of the resource.

This property reflects the ETag of the resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_hash Property

A SHA1 hash of the file resource's content.

Syntax

def get_resource_hash(resource_index: int) -> str: ...

Default Value

""

Remarks

A SHA1 hash of the file resource's content.

This property holds a SHA1 hash of the file resource's content. Not applicable for folder resources.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_id Property

The Id of the resource.

Syntax

def get_resource_id(resource_index: int) -> str: ...
def set_resource_id(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

The Id of the resource.

This property specifies the Id of the resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_modified_by Property

The email address of the user who last modified the resource.

Syntax

def get_resource_modified_by(resource_index: int) -> str: ...

Default Value

""

Remarks

The email address of the user who last modified the resource.

This property reflects the email address of the user who last modified the resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_modified_time Property

The last modified timestamp of the resource.

Syntax

def get_resource_modified_time(resource_index: int) -> str: ...

Default Value

""

Remarks

The last modified timestamp of the resource.

This property reflects the last modified timestamp of the resource. Timestamps are formatted according to RFC 3339.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_name Property

The name of the resource.

Syntax

def get_resource_name(resource_index: int) -> str: ...
def set_resource_name(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the resource.

This property specifies the name of the resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_owner Property

The email address of the user who owns the resource.

Syntax

def get_resource_owner(resource_index: int) -> str: ...

Default Value

""

Remarks

The email address of the user who owns the resource.

This property reflects the email address of the user who owns the resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_parent_id Property

The Id of the resource's parent.

Syntax

def get_resource_parent_id(resource_index: int) -> str: ...
def set_resource_parent_id(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

The Id of the resource's parent.

This property specifies the Id of the resource's parent.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_shared_link Property

The URL of the resource's shared link.

Syntax

def get_resource_shared_link(resource_index: int) -> str: ...

Default Value

""

Remarks

The URL of the resource's shared link.

This property holds the URL of the resource's shared link, or empty string if the resource doesn't currently have an active shared link.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_shared_link_access Property

Access level afforded by the resource's shared link.

Syntax

def get_resource_shared_link_access(resource_index: int) -> int: ...

Default Value

0

Remarks

Access level afforded by the resource's shared link.

This property reflects the access level that the resource's resource_shared_link provides. Possible values are:

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_shared_link_protected Property

Whether the resource's shared link is password-protected.

Syntax

def get_resource_shared_link_protected(resource_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the resource's shared link is password-protected.

This property indicates whether the resource's shared link is password-protected.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_size Property

The size of the resource.

Syntax

def get_resource_size(resource_index: int) -> int: ...

Default Value

0

Remarks

The size of the resource.

This property reflects the size of the resource, in bytes. For folder resources, this is the total size of everything within the folder.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_sync_state Property

The sync state of the folder resource.

Syntax

def get_resource_sync_state(resource_index: int) -> int: ...
def set_resource_sync_state(resource_index: int, value: int) -> None: ...

Default Value

0

Remarks

The sync state of the folder resource.

This property specifies the sync state of the folder resource. Not applicable for file resources. Possible values are:

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_tags Property

Tags applied to the resource.

Syntax

def get_resource_tags(resource_index: int) -> str: ...
def set_resource_tags(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

Tags applied to the resource.

This property specifies a comma-separated list of tags applied to the resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_trashed Property

Whether the resource is in the trash.

Syntax

def get_resource_trashed(resource_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the resource is in the trash.

This property indicates whether the resource has been moved to trash.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_trashed_time Property

The trashed timestamp of the resource.

Syntax

def get_resource_trashed_time(resource_index: int) -> str: ...

Default Value

""

Remarks

The trashed timestamp of the resource.

This property reflects the trashed timestamp of the resource. Timestamps are formatted according to RFC 3339.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_type Property

The resource's type.

Syntax

def get_resource_type(resource_index: int) -> int: ...

Default Value

0

Remarks

The resource's type.

This property indicates whether the resource is a folder or a file. Possible values are:

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_version_id Property

The version Id of the file resource.

Syntax

def get_resource_version_id(resource_index: int) -> str: ...

Default Value

""

Remarks

The version Id of the file resource.

This property reflects the version Id of the file resource. Not applicable for folder resources.

Note that Box only tracks file versions for paid accounts.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resume_url Property

The resumable upload URL.

Syntax

def get_resume_url() -> str: ...
def set_resume_url(value: str) -> None: ...

resume_url = property(get_resume_url, set_resume_url)

Default Value

""

Remarks

This property holds the URL of the resumable upload session. This is populated by the class automatically when use_resumable_upload is set to True and upload_file is called to initiate a new upload.

This must be set in order to resume an interrupted upload. See upload_file for details.

search_marker Property

A marker indicating what page of search results to return next.

Syntax

def get_search_marker() -> str: ...
def set_search_marker(value: str) -> None: ...

search_marker = property(get_search_marker, set_search_marker)

Default Value

""

Remarks

This property will be populated when search is called if the results are paged and there are more pages. To list all search results, continue to call search until this property returns empty string.

Refer to search for more information.

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.

start_byte Property

The byte offset from which to start the upload or download.

Syntax

def get_start_byte() -> int: ...
def set_start_byte(value: int) -> None: ...

start_byte = property(get_start_byte, set_start_byte)

Default Value

0

Remarks

This property may be set to resume an upload or download; it specifies the offset in the file from which to resume. See upload_file and download_file for details about resuming uploads and downloads.

timeout Property

The timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

use_resumable_upload Property

Whether to use resumable uploads.

Syntax

def get_use_resumable_upload() -> bool: ...
def set_use_resumable_upload(value: bool) -> None: ...

use_resumable_upload = property(get_use_resumable_upload, set_use_resumable_upload)

Default Value

FALSE

Remarks

This property controls whether simple or resumable uploads are used when upload_file is called. The default value is False (simple uploads are used).

Refer to upload_file for more information.

version_marker Property

A marker indicating what page of file versions to return next.

Syntax

def get_version_marker() -> str: ...
def set_version_marker(value: str) -> None: ...

version_marker = property(get_version_marker, set_version_marker)

Default Value

""

Remarks

This property will be populated when list_versions is called if the results are paged and there are more pages. To list all file versions, continue to call list_versions until this property returns empty string.

Refer to list_versions for more information.

abort_upload Method

Aborts the current resumable upload session.

Syntax

def abort_upload() -> None: ...

Remarks

This method aborts the current resumable upload session specified by resume_url. It may be called if the current resumable upload has been interrupted and will not be resumed.

add_query_param Method

Adds a query parameter to the QueryParams properties.

Syntax

def add_query_param(name: str, value: str) -> None: ...

Remarks

This method is used to add a query parameter to the query_params properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

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.

calc_authorization Method

Calculates the Authorization header based on provided credentials.

Syntax

def calc_authorization() -> None: ...

Remarks

This method calculates the authorization value using the values provided in auth_scheme, user and password.

In most cases this method does not need to be called. The class will automatically calculate any required authorization values when a method is called such as get or post.

This method may be useful in cases where the authorization value needs to be calculated prior to sending a request.

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.

copy_resource Method

Copies a resource.

Syntax

def copy_resource(resource_id: str, parent_id: str, new_name: str) -> str: ...

Remarks

This method copies the resource specified by ResourceId to the folder specified by ParentId. The Id of the newly-copied resource is returned.

NewName specifies the name of the copied resource; if empty, the resource's original name is used. ParentId can also be empty, in which case the resource is copied to the root folder.

NewName must be no longer than 255 characters; may not contain /, \, non-printable ASCII characters, or trailing whitespace; and cannot be one of the special names . or ...

Note that copy operations for folders with greater than 500 children (counted recursively) are performed asynchronously; the server will return the Id of the newly-copied folder resource immediately while continuing to perform the copy operation over time. There is no way to monitor an asynchronous copy operation.

create_folder Method

Creates a new folder resource.

Syntax

def create_folder(folder_name: str, parent_id: str) -> str: ...

Remarks

This method creates a new folder resource named FolderName in the folder specified by ParentId. The Id of the newly-created folder resource is returned.

FolderName must be no longer than 255 characters; may not contain /, \, non-printable ASCII characters, or trailing whitespace; and cannot be one of the special names . or ...

ParentId can be empty, in which case the folder is created in the root folder.

create_link Method

Creates a shared link.

Syntax

def create_link(resource_id: str) -> str: ...

Remarks

This method creates a shared link for the resource specified by ResourceId. The URL of the shared link is returned.

Only one shared link may be active at a time for each resource; calling this method for a resource that already has an active shared link will update the shared link's settings without changing its URL.

The following configuration settings may be used to configure the shared link:

• CreateLinkAccess
• CreateLinkAllowDownloads
• CreateLinkExpiration
• CreateLinkPassword

create_metadata Method

Creates a new metadata container on a resource.

Syntax

def create_metadata(resource_id: str, scope: str, schema: str) -> None: ...

Remarks

This method creates a new metadata container on the resource specified by ResourceId. The metadata container is created using the specified Scope and Schema.

Scope must be global or an enterprise-specific scope of the form enterprise_<EnterpriseId>. If Scope is empty, global is used.

If Scope is global, then Schema must be properties; otherwise, it must be the name of an existing metadata container schema owned by the enterprise identified in Scope. If Schema is empty, properties is used.

When this method is called, any metadata collection items that satisfy all of the following constraints will be added to the new metadata container immediately (assuming the server returns no errors):

• Their metadata_mod_op properties must be set to 1 (opAdd).
• Their metadata_resource_id properties must be empty, or must match the value provided for ResourceId.
• Their metadata_container_scope properties must be empty, or must match the value provided for Scope.
• Their metadata_container_schema properties must be empty, or must match the value provided for Schema.

All applicable metadata items will have their metadata_mod_op property reset to 0 (opNone) if the request succeeds.

Metadata Notes

Box's Metadata architecture consists of two entities: metadata items, and metadata containers (which Box calls "metadata templates").

A metadata item is just a name-value pair held by a metadata container. Its name may be up to 256 characters long, cannot begin with the $ character, and must be unique within the container.

A metadata container holds metadata items, and is associated with a single resource. All metadata containers must be created using a metadata container schema, which describes the possible metadata items the container may hold. Containers are uniquely identified (per-resource) by a schema path like /Scope/Schema (ergo, a resource cannot have multiple containers of the same schema).

Box provides a general-use schema, /global/properties, that functions as an unrestricted key-value store that will accept any metadata item. Enterprises can also create custom schemas, /enterprise_<EnterpriseId>/Schema, that only allow predefined metadata items (with specific data types) to be added.

See the following methods for more information: create_metadata, list_metadata, update_metadata, and delete_metadata.

Note that metadata is only usable on resources owned by paid Box accounts. string resId = "f:09876"; // Create an instance of the default metadata container ("/global/properties") with a couple of metadata // items in it, and associate it with the specified resource. (Note that we're assuming that the given // resource doesn't already have an instance of the default metadata container associated with it.) box.Metadata.Add(new BoxMetadata() { Name = "num1", Value = "123", ModOp = BoxMetadataModOps.opAdd }); box.Metadata.Add(new BoxMetadata() { Name = "text1", Value = "abc", ModOp = BoxMetadataModOps.opAdd }); // All of the class's metadata-related methods all empty string to be passed to their Scope and Schema // parameters, in which case "global" and "properties" will be used, respectively. (The exception is the // ListMetadata() method, which interprets empty Scope and Schema values in a different way; refer to the // ListMetadata() documentation for more information.) box.CreateMetadata(resId, "", ""); // Some time later, imagine you wish to update the metadata items held by the default container on that // resource. Always call ListMetadata() first so that class has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the class has the latest metadata items loaded for the default container on the given // resource, we can modify what we wish to, setting the ModOp fields appropriately. box.Metadata[0].Value = "456"; // Update the value of the "num1" item. box.Metadata[0].ModOp = BoxMetadataModOps.opReplace; box.Metadata[1].ModOp = BoxMetadataModOps.opRemove; // Remove the "text1" item. // Add a new "text2" item. box.Metadata.Add(new BoxMetadata() { Name = "text2", Value = "def", ModOp = BoxMetadataModOps.opAdd }); // Now commit the updates. Our example performs very simple updates, but you can build a very complex // update scenario using some of the other ModOp values. Refer to the UpdateMetadata() documentation // for more information. box.UpdateMetadata(resId, "", ""); // Finally, this will remove the entire default metadata container from the given resource. box.DeleteMetadata(resId, "", "");

create_preview_link Method

Creates a preview link.

Syntax

def create_preview_link(file_id: str) -> str: ...

Remarks

This method creates a preview link for the file resource specified by FileId. The URL of the preview link is returned. Preview links are suitable for embedding in iframes.

Note that preview links expire after 60 seconds, and the preview session expires after 60 minutes. Not all files support previewing.

delete_metadata Method

Deletes a metadata container from a resource.

Syntax

def delete_metadata(resource_id: str, scope: str, schema: str) -> None: ...

Remarks

This method deletes the metadata container specified by Scope and Schema from the resource specified by ResourceId. All metadata items held by the specified container are also deleted (individual metadata items can be deleted from a container using the update_metadata method; refer to its documentation for more information).

Scope must be global or an enterprise-specific scope of the form enterprise_<EnterpriseId>. If Scope is empty, global is used.

If Scope is global, then Schema must be properties; otherwise, it must be the name of an existing metadata container schema owned by the enterprise identified in Scope. If Schema is empty, properties is used.

Metadata Notes

Box's Metadata architecture consists of two entities: metadata items, and metadata containers (which Box calls "metadata templates").

A metadata item is just a name-value pair held by a metadata container. Its name may be up to 256 characters long, cannot begin with the $ character, and must be unique within the container.

A metadata container holds metadata items, and is associated with a single resource. All metadata containers must be created using a metadata container schema, which describes the possible metadata items the container may hold. Containers are uniquely identified (per-resource) by a schema path like /Scope/Schema (ergo, a resource cannot have multiple containers of the same schema).

Box provides a general-use schema, /global/properties, that functions as an unrestricted key-value store that will accept any metadata item. Enterprises can also create custom schemas, /enterprise_<EnterpriseId>/Schema, that only allow predefined metadata items (with specific data types) to be added.

See the following methods for more information: create_metadata, list_metadata, update_metadata, and delete_metadata.

Note that metadata is only usable on resources owned by paid Box accounts. string resId = "f:09876"; // Create an instance of the default metadata container ("/global/properties") with a couple of metadata // items in it, and associate it with the specified resource. (Note that we're assuming that the given // resource doesn't already have an instance of the default metadata container associated with it.) box.Metadata.Add(new BoxMetadata() { Name = "num1", Value = "123", ModOp = BoxMetadataModOps.opAdd }); box.Metadata.Add(new BoxMetadata() { Name = "text1", Value = "abc", ModOp = BoxMetadataModOps.opAdd }); // All of the class's metadata-related methods all empty string to be passed to their Scope and Schema // parameters, in which case "global" and "properties" will be used, respectively. (The exception is the // ListMetadata() method, which interprets empty Scope and Schema values in a different way; refer to the // ListMetadata() documentation for more information.) box.CreateMetadata(resId, "", ""); // Some time later, imagine you wish to update the metadata items held by the default container on that // resource. Always call ListMetadata() first so that class has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the class has the latest metadata items loaded for the default container on the given // resource, we can modify what we wish to, setting the ModOp fields appropriately. box.Metadata[0].Value = "456"; // Update the value of the "num1" item. box.Metadata[0].ModOp = BoxMetadataModOps.opReplace; box.Metadata[1].ModOp = BoxMetadataModOps.opRemove; // Remove the "text1" item. // Add a new "text2" item. box.Metadata.Add(new BoxMetadata() { Name = "text2", Value = "def", ModOp = BoxMetadataModOps.opAdd }); // Now commit the updates. Our example performs very simple updates, but you can build a very complex // update scenario using some of the other ModOp values. Refer to the UpdateMetadata() documentation // for more information. box.UpdateMetadata(resId, "", ""); // Finally, this will remove the entire default metadata container from the given resource. box.DeleteMetadata(resId, "", "");

delete_resource Method

Trashes or permanently deletes a resource.

Syntax

def delete_resource(resource_id: str) -> None: ...

Remarks

This method trashes the resource specified by ResourceId. If the resource is already in the trash, it is permanently deleted instead.

To list trashed resources, call list_resources and pass trash for the FolderId method parameter.

download_file Method

Downloads a file resource.

Syntax

def download_file(file_id: str) -> None: ...

Remarks

This method downloads the file resource specified by FileId.

The download_type property can be used to control whether this method downloads the file contents (default) or a file thumbnail. Refer to download_type for more information.

If local_file is set, the file will be saved to the specified location; otherwise, the file data will be held by resource_data.

To download and decrypt an encrypted file, set encryption_algorithm and encryption_password before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: box.LocalFile = "../MyFile.zip"; box.DownloadFile(box.Resources[0].Id);

Resuming Downloads

The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; box.LocalFile = downloadFile; box.DownloadFile(box.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file box.StartByte = new FileInfo(downloadFile).Length; box.DownloadFile(box.Resources[0].Id);

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file. box.LocalFile = "../MyFile.zip"; box.EncryptionPassword = "password"; box.DownloadFile(box.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file box.StartByte = new FileInfo(box.Config("DownloadTempFile")).Length; box.DownloadFile(box.Resources[0].Id);

get_account_info Method

Gets information about the current user's account and space usage.

Syntax

def get_account_info() -> None: ...

Remarks

This method gets information about the current user's account and space usage, populating the account object property's properties.

get_resource_info Method

Gets information about a specific resource.

Syntax

def get_resource_info(resource_id: str) -> None: ...

Remarks

This method gets information about the resource specified by ResourceId.

ResourceId can be empty string to get information about the root folder.

Calling this method will fire the on_resource_list event, and will populate the resources properties with a single item (clearing any previously-held items in the process).

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

list_metadata Method

Lists the metadata items for a resource.

Syntax

def list_metadata(resource_id: str, scope: str, schema: str) -> None: ...

Remarks

This method lists the metadata items for the resource specified by ResourceId. If Scope and Schema are both empty, metadata items from all metadata containers associated with the resource are returned. Otherwise, only the items in the container specified by Scope and Schema are returned.

When non-empty, Scope and Schema must either be global and properties (respectively); or enterprise_<EnterpriseId> and the name of an existing metadata container within that scope on the specified resource.

Calling this method will fire the on_metadata_list event once for each metadata item, and will populate the metadata properties (clearing any previously-held items in the process).

Metadata Notes

Box's Metadata architecture consists of two entities: metadata items, and metadata containers (which Box calls "metadata templates").

A metadata item is just a name-value pair held by a metadata container. Its name may be up to 256 characters long, cannot begin with the $ character, and must be unique within the container.

A metadata container holds metadata items, and is associated with a single resource. All metadata containers must be created using a metadata container schema, which describes the possible metadata items the container may hold. Containers are uniquely identified (per-resource) by a schema path like /Scope/Schema (ergo, a resource cannot have multiple containers of the same schema).

Box provides a general-use schema, /global/properties, that functions as an unrestricted key-value store that will accept any metadata item. Enterprises can also create custom schemas, /enterprise_<EnterpriseId>/Schema, that only allow predefined metadata items (with specific data types) to be added.

See the following methods for more information: create_metadata, list_metadata, update_metadata, and delete_metadata.

Note that metadata is only usable on resources owned by paid Box accounts. string resId = "f:09876"; // Create an instance of the default metadata container ("/global/properties") with a couple of metadata // items in it, and associate it with the specified resource. (Note that we're assuming that the given // resource doesn't already have an instance of the default metadata container associated with it.) box.Metadata.Add(new BoxMetadata() { Name = "num1", Value = "123", ModOp = BoxMetadataModOps.opAdd }); box.Metadata.Add(new BoxMetadata() { Name = "text1", Value = "abc", ModOp = BoxMetadataModOps.opAdd }); // All of the class's metadata-related methods all empty string to be passed to their Scope and Schema // parameters, in which case "global" and "properties" will be used, respectively. (The exception is the // ListMetadata() method, which interprets empty Scope and Schema values in a different way; refer to the // ListMetadata() documentation for more information.) box.CreateMetadata(resId, "", ""); // Some time later, imagine you wish to update the metadata items held by the default container on that // resource. Always call ListMetadata() first so that class has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the class has the latest metadata items loaded for the default container on the given // resource, we can modify what we wish to, setting the ModOp fields appropriately. box.Metadata[0].Value = "456"; // Update the value of the "num1" item. box.Metadata[0].ModOp = BoxMetadataModOps.opReplace; box.Metadata[1].ModOp = BoxMetadataModOps.opRemove; // Remove the "text1" item. // Add a new "text2" item. box.Metadata.Add(new BoxMetadata() { Name = "text2", Value = "def", ModOp = BoxMetadataModOps.opAdd }); // Now commit the updates. Our example performs very simple updates, but you can build a very complex // update scenario using some of the other ModOp values. Refer to the UpdateMetadata() documentation // for more information. box.UpdateMetadata(resId, "", ""); // Finally, this will remove the entire default metadata container from the given resource. box.DeleteMetadata(resId, "", "");

list_resources Method

Lists resources.

Syntax

def list_resources(folder_id: str) -> None: ...

Remarks

This method lists resources within the folder specified by FolderId.

FolderId can be empty string to list resources in the root folder, or trash to list trashed resources.

Calling this method will fire the on_resource_list event once for each resource, and will also populate the resources properties.

If there are still more resources available to list when this method returns, the resource_marker property will be populated. Continue to call this method until resource_marker is empty to accumulate all pages of results in the resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the resources properties every time a page of results is returned.

The MaxResults configuration setting can be used to control the maximum number of results to return at once. // ResourceList event handler. box.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; do { box.ListResources("d:123456"); for (int i = 0; i < box.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(box.ResourceMarker));

list_versions Method

Lists previous versions of a file resource.

Syntax

def list_versions(file_id: str) -> None: ...

Remarks

This method lists previous versions of the file resource specified by FileId. The current version is not included in the results.

Calling this method will fire the on_resource_list event once for each file version, and will also populate the resources properties.

If there are still more file versions available to list when this method returns, the version_marker property will be populated. Continue to call this method until version_marker is empty to accumulate all pages of results in the resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the resources properties every time a page of results is returned.

Note that Box only returns certain resource details when listing file versions; this is a limitation of the Box API that cannot be changed. Specifically, the following properties are returned:

• resource_created_time
• resource_hash
• resource_id (populated by the class for convenience)
• resource_modified_by
• resource_modified_time
• resource_name
• resource_size
• resource_type (always 0 (brtFile))
• resource_version_id

The MaxResults configuration setting can be used to control the maximum number of results to return at once.

Note that Box only tracks file versions for paid accounts. // ResourceList event handler. box.OnResourceList += (s, e) => { Console.WriteLine(e.Name + ", Version: " + e.VersionId); }; do { box.ListVersions("f:09876"); for (int i = 0; i < box.Resources.Count; i++) { // Process resource versions here. } } while (!string.IsNullOrEmpty(box.VersionMarker));

lock_file Method

Locks a file resource.

Syntax

def lock_file(file_id: str, expiration: str, allow_downloading: bool) -> None: ...

Remarks

This method locks the file resource specified by FileId to prevent others from modifying it.

Expiration may be set to an appropriately-formatted timestamp to specify an expiration time for the file lock. If Expiration is empty, the file lock will never expire. Timestamps are formatted according to RFC 3339.

AllowDownloading specifies whether others should still be allowed to download the file while it's locked.

move_resource Method

Moves a resource.

Syntax

def move_resource(resource_id: str, parent_id: str, new_name: str) -> None: ...

Remarks

This method moves the resource specified by ResourceId to the folder specified by ParentId.

NewName specifies the new name of the resource; if empty, the resource's original name is used. ParentId can also be empty, in which case the resource is moved to the root folder.

NewName must be no longer than 255 characters; may not contain /, \, non-printable ASCII characters, or trailing whitespace; and cannot be one of the special names . or ...

When moving a folder that contains many items, keep in mind that Box always performs move operations synchronously (whereas copy operations are performed asynchronously for folders that contain more than 500 items). This method will block until the move operation completes, unless the class times out the request based on the current value of timeout.

poll_upload_status Method

Gets the status of the current resumable upload session.

Syntax

def poll_upload_status() -> None: ...

Remarks

This method retrieves the status of the resumable upload session specified by resume_url.

After calling this method, the start_byte property and UploadExpDate and UploadFragmentSize configuration settings will be populated.

promote_version Method

Promotes a previous file resource version to be the current version.

Syntax

def promote_version(file_id: str, version_id: str) -> None: ...

Remarks

This method promotes a previous version of the file resource specified by FileId to be the current version.

VersionId specifies the version that should be promoted. Box will make a copy of it to use as the new version.

Note that Box only tracks file versions for paid accounts.

reset Method

Resets the class to its initial state.

Syntax

def reset() -> None: ...

Remarks

This method resets the class to its initial state.

restore_resource Method

Restores a resource from the trash.

Syntax

def restore_resource(resource_id: str, parent_id: str, new_name: str) -> None: ...

Remarks

This method restores the resource specified by ResourceId from the trash.

Box will always ignore ParentId and/or NewName in favor of restoring a trashed resource to its original location with its original name if possible. The ParentId and NewName parameters are only considered if one or both of the following are true:

• The original parent folder resource no longer exists (in which case ParentId will be used instead, if not empty).
• The original resource name is already in use in the original (or new) parent folder (in which case NewName will be used instead, if not empty).

revoke_link Method

Revokes a shared link.

Syntax

def revoke_link(resource_id: str) -> None: ...

Remarks

This method revokes the shared link for the resource specified by ResourceId. If the specified resource doesn't have a shared link active, this method does nothing.

search Method

Searches for resources that match the specified query.

Syntax

def search(query: str) -> None: ...

Remarks

This method searches for resources that match the given Query, which the server will match against names, descriptions, file contents, etc.

Advanced searches can be performed by adding additional query parameters using the add_query_param method. Here are examples of some of the more common query parameters:

Calling this method will fire the on_resource_list event once for each search result, and will also populate the resources properties.

If there are still more search results available to list when this method returns, the search_marker property will be populated. Continue to call this method until search_marker is empty to accumulate all pages of results in the resources properties.

The MaxSearchResults configuration setting can be used to control the maximum number of results to return at once.

send_custom_request Method

Sends a custom request to the Box API.

Syntax

def send_custom_request(http_method: str, request_path: str, request_body: str) -> None: ...

Remarks

This method can be used to send arbitrary requests to the Box API.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• DELETE

The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Box API. The RequestBody parameter may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the Box API endpoint, https://api.box.com/2.0.
   • All query parameters in the query_params properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by authorization and other_headers, and the given RequestBody (if non-empty).
3. Stores the response headers in the parsed_headers properties, and the response body in the specified local_file, or resource_data (using the same logic as download_file).

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

unlock_file Method

Unlocks a locked file resource.

Syntax

def unlock_file(file_id: str) -> None: ...

Remarks

This method unlocks a file resource, specified by FileId, previously locked by the current account.

update_metadata Method

Updates the metadata items for an existing metadata container.

Syntax

def update_metadata(resource_id: str, scope: str, schema: str) -> None: ...

Remarks

This method updates the metadata items for an existing metadata container, specified by Scope and Schema, that is associated with the resource specified by ResourceId.

Scope must be global or an enterprise-specific scope of the form enterprise_<EnterpriseId>. If Scope is empty, global is used.

If Scope is global, then Schema must be properties; otherwise, it must be the name of an existing metadata container schema owned by the enterprise identified in Scope. If Schema is empty, properties is used.

Each item in the metadata properties has a metadata_mod_op property which can be set to one of the following values:

When this method is called, the class will iterate through the metadata properties and build up a modification request that includes the specified operation for each applicable metadata item. For a metadata item to be included in the request, all of the following must be true:

• Its metadata_mod_op property must not be set to 0 (opNone).
• Its metadata_resource_id property must be empty, or must match the value provided for ResourceId.
• Its metadata_container_scope property must be empty, or must match the value provided for Scope.
• Its metadata_container_schema property must be empty, or must match the value provided for Schema.

A couple of things to keep in mind regarding metadata item modification operations:

• Box applies each modification operation in the request sequentially, so the order in which they are transmitted is significant (though it may not impact all use-cases).
  • By default, the class transmits the applicable modification operations based on the order of the metadata items.
  • To specify an explicit order, the MetadataUpdateOrder configuration setting can be set to a comma-separated list of metadata item indices.
• Box guarantees overall atomicity for the request; if the modification operation for any one item fails, then the whole request fails, and no changes are made.
• If the request completes successfully, the class will reset all affected metadata items' metadata_mod_op properties back to 0 (opNone).

Usage

list_metadata must be called before using this method in order to populate the metadata properties with a resource's existing metadata items. (When creating new metadata items, calling list_metadata first is optional, but still recommended to ensure that the class reflects the latest information.)

To create new metadata items, add new items to the metadata properties by incrementing the MetadataCount property as necessary.

For each metadata item being created or updated, set its properties to the desired values. The metadata_mod_op property should be set to a value other than 0 (opNone).

Once the metadata items have been set up as desired, call this method.

Metadata Notes

Box's Metadata architecture consists of two entities: metadata items, and metadata containers (which Box calls "metadata templates").

A metadata item is just a name-value pair held by a metadata container. Its name may be up to 256 characters long, cannot begin with the $ character, and must be unique within the container.

A metadata container holds metadata items, and is associated with a single resource. All metadata containers must be created using a metadata container schema, which describes the possible metadata items the container may hold. Containers are uniquely identified (per-resource) by a schema path like /Scope/Schema (ergo, a resource cannot have multiple containers of the same schema).

Box provides a general-use schema, /global/properties, that functions as an unrestricted key-value store that will accept any metadata item. Enterprises can also create custom schemas, /enterprise_<EnterpriseId>/Schema, that only allow predefined metadata items (with specific data types) to be added.

See the following methods for more information: create_metadata, list_metadata, update_metadata, and delete_metadata.

Note that metadata is only usable on resources owned by paid Box accounts. string resId = "f:09876"; // Create an instance of the default metadata container ("/global/properties") with a couple of metadata // items in it, and associate it with the specified resource. (Note that we're assuming that the given // resource doesn't already have an instance of the default metadata container associated with it.) box.Metadata.Add(new BoxMetadata() { Name = "num1", Value = "123", ModOp = BoxMetadataModOps.opAdd }); box.Metadata.Add(new BoxMetadata() { Name = "text1", Value = "abc", ModOp = BoxMetadataModOps.opAdd }); // All of the class's metadata-related methods all empty string to be passed to their Scope and Schema // parameters, in which case "global" and "properties" will be used, respectively. (The exception is the // ListMetadata() method, which interprets empty Scope and Schema values in a different way; refer to the // ListMetadata() documentation for more information.) box.CreateMetadata(resId, "", ""); // Some time later, imagine you wish to update the metadata items held by the default container on that // resource. Always call ListMetadata() first so that class has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the class has the latest metadata items loaded for the default container on the given // resource, we can modify what we wish to, setting the ModOp fields appropriately. box.Metadata[0].Value = "456"; // Update the value of the "num1" item. box.Metadata[0].ModOp = BoxMetadataModOps.opReplace; box.Metadata[1].ModOp = BoxMetadataModOps.opRemove; // Remove the "text1" item. // Add a new "text2" item. box.Metadata.Add(new BoxMetadata() { Name = "text2", Value = "def", ModOp = BoxMetadataModOps.opAdd }); // Now commit the updates. Our example performs very simple updates, but you can build a very complex // update scenario using some of the other ModOp values. Refer to the UpdateMetadata() documentation // for more information. box.UpdateMetadata(resId, "", ""); // Finally, this will remove the entire default metadata container from the given resource. box.DeleteMetadata(resId, "", "");

update_resource Method

Updates a resource.

Syntax

def update_resource(resource_id: str) -> None: ...

Remarks

This method updates the information for the resource specified by ResourceId. For file resources, the file data can optionally be updated as well.

Usage

There must be a BoxResource properties whose resource_id property matches the given ResourceId parameter before this method is called.

1. If necessary, call get_resource_info or list_resources to ensure an item with the resource's latest information is present in the resources properties.
2. Modify the item's Resource* properties as desired; the following properties are supported:
   • resource_description
   • resource_name (the same restrictions as described in upload_file apply)
   • resource_parent_id (only updated if not empty; d:0 can be used to move the resource to the root folder)
   • resource_sync_state (only applicable for folder resources; only updated if set to 1 (ssSynced) or 2 (ssNotSynced))
   • resource_tags
3. For file resources, you may set local_file or resource_data if you wish to update the file data on the server. (Refer to upload_file for more information about simple vs. resumable uploads and encrypting the file data before uploading.)
   • Like with upload_file, the ClientModifiedTime configuration setting may be set when updating file data.
4. Finally, call this method to update the resource.

upload_file Method

Uploads a new file resource.

Syntax

def upload_file(file_name: str, parent_id: str) -> str: ...

Remarks

This method uploads a new file resource named FileName to the folder specified by ParentId. The Id of the newly-created file resource is returned.

FileName must be no longer than 255 characters; may not contain /, \, non-printable ASCII characters, or trailing whitespace; and cannot be one of the special names . or ...

ParentId can be empty, in which case the file is uploaded to the root folder.

The ClientCreatedTime and ClientModifiedTime configuration settings may be set before calling this method to submit those timestamps along with the file data.

If local_file is set the file will be uploaded from the specified path. If local_file is not set the data in resource_data will be used.

To encrypt the file before uploading it, set encryption_algorithm and encryption_password.

Upload Notes

Box offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files (must be larger than 20 MB), uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. When doing a simple upload, the HashSimpleUploads setting is applicable. box.LocalFile = "../MyFile.zip"; box.UploadFile("MyFile.zip", "");

Resumable

To enable resumable uploads set use_resumable_upload to True. This is recommended for large files (must be larger than 20 MB). The class will automatically fragment the specified file into smaller pieces and upload each individually.

When use_resumable_upload is set to True and upload_file is called, a resumable upload session is started by the class. resume_url is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the on_fragment_complete event fires after each fragment is uploaded to indicate overall progress. The class also updates start_byte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that resume_url is populated (if the same instance of the class is used, it should already be populated, and no special action should be needed). Call poll_upload_status to populate the correct values for start_byte and UploadFragmentSize. Then call upload_file again to resume the upload at the specified start_byte offset.

Note that if the upload is not resumed after some time the upload session will expire. poll_upload_status may be used to check the status of a resumable upload, including when it will expire (which is stored in the UploadExpDate configuration setting). An interrupted upload can be aborted explicitly using the abort_upload method. box.LocalFile = "../MyFile.zip"; box.UploadFile("MyFile.zip", ""); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. box.UploadFile("MyFile.zip", "");

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

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

# In class Box:
@property
def on_end_transfer() -> Callable[[BoxEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[BoxEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

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

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Fires after each fragment of a resumable upload is completed.

Syntax

class BoxFragmentCompleteEventParams(object):
  @property
  def fragment_number() -> int: ...

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

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

# In class Box:
@property
def on_fragment_complete() -> Callable[[BoxFragmentCompleteEventParams], None]: ...
@on_fragment_complete.setter
def on_fragment_complete(event_hook: Callable[[BoxFragmentCompleteEventParams], None]) -> None: ...

Remarks

When use_resumable_upload is True and upload_file is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current fragment that has completed. This value starts at 1.

FragmentCount is the total number of fragments that will be uploaded.

Interrupt can be set to True to interrupt the upload. The upload may be resumed later.

on_header Event

Fired every time a header line comes in.

Syntax

class BoxHeaderEventParams(object):
  @property
  def field() -> str: ...

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

# In class Box:
@property
def on_header() -> Callable[[BoxHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[BoxHeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_log Event

Fired once for each log message.

Syntax

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

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

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

# In class Box:
@property
def on_log() -> Callable[[BoxLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[BoxLogEventParams], 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_metadata_list Event

Fires once for each metadata item when listing a resource metadata.

Syntax

class BoxMetadataListEventParams(object):
  @property
  def name() -> str: ...

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

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

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

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

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

# In class Box:
@property
def on_metadata_list() -> Callable[[BoxMetadataListEventParams], None]: ...
@on_metadata_list.setter
def on_metadata_list(event_hook: Callable[[BoxMetadataListEventParams], None]) -> None: ...

Remarks

This event fires once for each metadata item returned when list_metadata is called.

Name is the name of the metadata item.

Value is the value of the metadata item.

ValueType is the value of the metadata item. Possible values, and their corresponding Box types, are:

ContainerScope is the scope that the metadata item's container resides in.

ContainerSchema is the schema of the metadata item's container.

ResourceId is the Id of the resource that the metadata is associated with.

Note that metadata is only usable on resources owned by paid Box accounts.

on_progress Event

Fires during an upload or download to indicate transfer progress.

Syntax

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

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

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

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

# In class Box:
@property
def on_progress() -> Callable[[BoxProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[BoxProgressEventParams], None]) -> None: ...

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

on_resource_list Event

Fires once for each resource returned when listing resources or versions.

Syntax

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

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

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

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

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

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

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

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

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

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

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

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

# In class Box:
@property
def on_resource_list() -> Callable[[BoxResourceListEventParams], None]: ...
@on_resource_list.setter
def on_resource_list(event_hook: Callable[[BoxResourceListEventParams], None]) -> None: ...

Remarks

This event fires once for each resource returned when list_resources, get_resource_info, search, or list_versions is called.

Id is the Id of the resource.

Name is the name of the resource.

Description is a description of the resource.

ResourceType reflects the resource's type. Possible values are:

CreatedTime and ModifiedTime reflect the resource's creation and last modified timestamps. Timestamps are formatted according to RFC 3339.

Size is the size of the resource (for folders, their contents' total size), in bytes.

VersionId is the version Id of the file resource. Not applicable for file resources. (Note that Box only tracks file versions for paid accounts.)

ETag is the ETag of the resource.

Hash holds a SHA1 hash of the file resource's content. Not applicable for folder resources.

Trashed indicates whether the resource is in the trash.

SharedLink is the shared link URL for the resource. May be empty if the resource doesn't have a shared link active.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class BoxSSLServerAuthenticationEventParams(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 Box:
@property
def on_ssl_server_authentication() -> Callable[[BoxSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[BoxSSLServerAuthenticationEventParams], 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 BoxSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

on_start_transfer Event

This event fires when a document starts transferring (after the headers).

Syntax

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

# In class Box:
@property
def on_start_transfer() -> Callable[[BoxStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[BoxStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

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

on_transfer Event

Fired while a document transfers (delivers document).

Syntax

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

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

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

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

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

Box Config Settings

Box 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