User Certificate Creation

class UserCertificateCreation(api)

Bases: _ClientWorkBase

create(name, certificate_container, ca_template, contacts, description=None, naming_pattern='$Identity[$Client.Identity$, "userPrincipalName"]$', common_name='$Identity[$Client.Identity$,"cn"]$', organization='$Identity[$Client.Identity$,"company"]$', organizational_unit=['$Identity[$Client.Identity$,"department"]$'], city_locality='$Identity[$Client.Identity$,"l"]$', state_province='$Identity[$Client.Identity$,"st"]$', country='$Identity[$Client.Identity$,"c"]$', user_email=False, subject_alt_names_email=False, subject_alt_names_upn=False, key_bit_strength=2048, automatic_renewal=True, renewal_days_before=30, configure_outlook=False, outlook_security_name='', outlook_encrypt_messages=False, outlook_send_cleartext_signed=False, outlook_sign_outgoing=False, outlook_request_receipts=False, publish_to_identity_provider=False, publish_pre_enrollment=False, install_previous_certs=False, allow_mobile_sharing=False, lifecycle_groups=None, lifecycle_revoke_cert=False, lifecycle_disable_cert=False, portal_friendly_name=None, portal_icon=0, portal_download_limit=3, portal_instructions=None, attributes=None, get_if_already_exists=True)
Parameters:

  • name (str) – The name of the client work.

  • certificate_container (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the folder to place certificates.

  • ca_template (Union[config.Object, str]) – Config Object or DN of the Certificate Authority.

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

  • description (str) – Description for the certificates

  • naming_pattern (str) – Object naming pattern

  • common_name (str) – Common name for the certificate

  • organization (str) – Organization for the certificate

  • organizational_unit (list[str]) – A list of organizational units for the certificate

  • city_locality (str) – A city or locality for the certificate

  • state_province (str) – A state or province for the certificate

  • country (str) – A country code for the certificate

  • user_email (bool) – Add user’s email to the certificate

  • subject_alt_names_email (bool) – Use subject alternative name email for the certificate

  • subject_alt_names_upn (bool) – Use subject alternative upn for the certificate

  • key_bit_strength (int) – The key size of the certificate

  • automatic_renewal (bool) – Enable automatic renewal for the certificate

  • renewal_days_before (int) – The number of days before expiration to renew the certificate

  • configure_outlook (bool) – Configure Microsoft Outlook for Windows

  • outlook_security_name (str) – Security settings name

  • outlook_encrypt_messages (bool) – Encrypt outgoing messages

  • outlook_send_cleartext_signed (bool) – Send cleartext signed messages

  • outlook_sign_outgoing (bool) – Sign outgoing messages

  • outlook_request_receipts (bool) – Request S/MIME receipts

  • publish_to_identity_provider (bool) – Publish to identity provider

  • publish_pre_enrollment (bool) – Publish when a new identity is found (pre-enrollment)

  • install_previous_certs (bool) – Install previous certificate versions

  • allow_mobile_sharing (bool) – Allow certificate sharing with mobile devices

  • lifecycle_groups (list[Union[config.Object, str]]) – A list of Config Object or Distinguished Name (DN) of groups such that when a member is removed from all groups in the list the certificate can be revoked and/or disabled

  • lifecycle_revoke_cert (bool) – Revoke certificates when a user’s membership is removed from all lifecycle groups

  • lifecycle_disable_cert (bool) – Disable certificates when a user’s membership is removed from all lifecycle groups

  • portal_friendly_name (str) – Portal friendly name

  • portal_icon (int) – Portal icon: 0 - certificate 1 - Envelope 2 - Wi-Fi 3 - VPN

  • portal_download_limit (int) – Limit the number of portal downloads

  • portal_instructions (str) – Text of portal download instructions

  • attributes (dict) – Additional attributes to apply to the object.

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

Returns:

Config Object of the client work.

delete(work)

Deletes the client work.

Parameters:

work (Union[config.Object, str]) – Config Object or name of the client work.

disable(work)

Disables the client work.

Parameters:

work (Union[config.Object, str]) – Config Object or name of the client work.

enable(work)

Enables the client work.

Parameters:

work (Union[config.Object, str]) – Config Object or name of the client work.

get(name, raise_error_if_not_exists=True)
Parameters:

  • name (str) – The name of the client work.

  • raise_error_if_not_exists (bool) – Raise an exception if the client work does not exist.

Returns:

Config Object of the client work.

list()

Lists all client work.

Returns:

List of Config Object of all client work.