Microsoft CA

class MSCA(api)

Bases: _CertificateAuthorityBase

create(name, parent_folder, hostname, service_name, credential, template, description=None, contacts=None, manual_approvals=None, subject_alt_name_enabled=None, automatically_include_cn_as_dns_san=None, allow_users_to_specify_end_date=None, enrollment_agent=None, attributes=None, get_if_already_exists=True)
Parameters

  • name (str) – Name of the CA object.

  • parent_folder (Union[config.Object, str]) – :ref:`config_object or Distinguished Name (DN) of the parent folder of this certificate authority object.

  • hostname (str) – Hostname or IP Address of the CA.

  • service_name (str) – Service, or Given, Name of the certificate authority.

  • credential (Union[config.Object, str]) – :ref:`config_object or Distinguished Name (DN) of the CA credential.

  • template (str) – Name of the CA template.

  • description (str) – Description of the CA object.

  • contacts (List[ident.Identity, str]) – List of Identity Object or Prefixed Name of the contacts.

  • manual_approvals (bool) – Require manual approvals.

  • subject_alt_name_enabled (bool) – Enable Subject Alternative Names.

  • automatically_include_cn_as_dns_san (bool) – Automatically include the common name (CN) as a DNS SAN.

  • allow_users_to_specify_end_date (bool) – Allow users to specify the end date.

  • enrollment_agent (Union[config.Object, str]) – :ref:`config_object or Distinguished Name (DN) of the certificate credential, or enrollment agent.

  • attributes (dict) – Additional attributes associated to the CA object.

  • get_if_already_exists (bool) – If the objects already exists, just return it as is.

Returns

Config Object of the certificate authority.

delete(certificate_authority)

Deletes the certificate authority object from TPP, including all of the secrets associated to it.

Parameters

certificate_authority (Union[config.Object, str]) – Config Object or Distinguished Name (DN) for the certificate authority object.

get(certificate_authority_dn, raise_error_if_not_exists=True)

Get the certificate authority object in TPP.

Parameters
Returns

Config Object of the certificate authority.