Global Configuration

class CodeSignGlobalConfiguration(api)

Bases: FeatureBase

Parameters:

api (Authenticate)

get()

Returns settings that apply to all CodeSign Protect projects.

Returns:

GlobalConfiguration

Return type:

GlobalConfiguration

set(global_configuration)

Update global configuration settings for CodeSign Protect.

Parameters:

global_configuration (GlobalConfiguration) – GlobalConfiguration

set_values(approved_key_storage_locations=None, available_key_storage_locations=None, default_ca_container=None, default_certificate_container=None, default_credential_container=None, key_use_timeout=None, project_description_tooltip=None, request_in_progress_message=None)

Update specific value(s) on the existing global configuration settings for CodeSign Protect.

Parameters:

  • approved_key_storage_locations (list[Literal['Software', 'HSM']]) – Key storage locations that are approved for use with CodeSign Protect. This information is also available in the Encryption tree.

  • available_key_storage_locations (list[Literal['Software', 'HSM']]) – Available key storage locations, such as HSM and Venafi key storage locations.

  • default_ca_container (str) – Distinguished Name (DN) of container where CodeSign Protect creates and stores CA templates.

  • default_certificate_container (str) – The default Distinguished Name (DN) of container that holds certificate objects.

  • default_credential_container (str) – The default Distinguished Name (DN) of container that holds credentials.

  • key_use_timeout (int) – The number of seconds a client should wait for a response when attempting to use a key. The default is 120.

  • project_description_tooltip (str) – A description that appears when a project owner is creating a project.

  • request_in_progress_message (str) – The message that appears when a KeyUser attempts to access a key that requires approval.