Skip to content

ImportCertificateRequest

Source code in docs_src/capo_transfer/types/import_certificate_request.py
class ImportCertificateRequest(TypedDict, closed=True):
    usage: "capo_transfer.types.certificate_usage_type.CertificateUsageType"
    """<p>Specifies how this certificate is used. It can be used in the following ways:</p> <ul> <li> <p> <code>SIGNING</code>: For signing AS2 messages</p> </li> <li> <p> <code>ENCRYPTION</code>: For encrypting AS2 messages</p> </li> <li> <p> <code>TLS</code>: For securing AS2 communications sent over HTTPS</p> </li> </ul>"""
    certificate: "capo_transfer.types.certificate_body_type.CertificateBodyType"
    """<ul> <li> <p>For the CLI, provide a file path for a certificate in URI format. For example, <code>--certificate file://encryption-cert.pem</code>. Alternatively, you can provide the raw content.</p> </li> <li> <p>For the SDK, specify the raw content of a certificate file. For example, <code>--certificate "`cat encryption-cert.pem`"</code>.</p> </li> </ul> <note> <p>You can provide both the certificate and its chain in this parameter, without needing to use the <code>CertificateChain</code> parameter. If you use this parameter for both the certificate and its chain, do not use the <code>CertificateChain</code> parameter.</p> </note>"""
    certificate_chain: NotRequired[
        "capo_transfer.types.certificate_chain_type.CertificateChainType"
    ]
    """<p>An optional list of certificates that make up the chain for the certificate that's being imported.</p>"""
    private_key: NotRequired["capo_transfer.types.private_key_type.PrivateKeyType"]
    """<ul> <li> <p>For the CLI, provide a file path for a private key in URI format. For example, <code>--private-key file://encryption-key.pem</code>. Alternatively, you can provide the raw content of the private key file.</p> </li> <li> <p>For the SDK, specify the raw content of a private key file. For example, <code>--private-key "`cat encryption-key.pem`"</code> </p> </li> </ul>"""
    active_date: NotRequired["capo_transfer.types.cert_date.CertDate"]
    """<p>An optional date that specifies when the certificate becomes active. If you do not specify a value, <code>ActiveDate</code> takes the same value as <code>NotBeforeDate</code>, which is specified by the CA. </p>"""
    inactive_date: NotRequired["capo_transfer.types.cert_date.CertDate"]
    """<p>An optional date that specifies when the certificate becomes inactive. If you do not specify a value, <code>InactiveDate</code> takes the same value as <code>NotAfterDate</code>, which is specified by the CA.</p>"""
    description: NotRequired["capo_transfer.types.description.Description"]
    """<p>A short description that helps identify the certificate. </p>"""
    tags: NotRequired["capo_transfer.types.tags.Tags"]
    """<p>Key-value pairs that can be used to group and search for certificates.</p>"""

active_date instance-attribute

active_date: NotRequired[CertDate]

An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

certificate instance-attribute

certificate: CertificateBodyType
  • For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.

  • For the SDK, specify the raw content of a certificate file. For example, --certificate "`cat encryption-cert.pem`".

You can provide both the certificate and its chain in this parameter, without needing to use the CertificateChain parameter. If you use this parameter for both the certificate and its chain, do not use the CertificateChain parameter.

certificate_chain instance-attribute

certificate_chain: NotRequired[CertificateChainType]

An optional list of certificates that make up the chain for the certificate that's being imported.

description instance-attribute

description: NotRequired[Description]

A short description that helps identify the certificate.

inactive_date instance-attribute

inactive_date: NotRequired[CertDate]

An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

private_key instance-attribute

private_key: NotRequired[PrivateKeyType]
  • For the CLI, provide a file path for a private key in URI format. For example, --private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.

  • For the SDK, specify the raw content of a private key file. For example, --private-key "`cat encryption-key.pem`"

tags instance-attribute

tags: NotRequired[Tags]

Key-value pairs that can be used to group and search for certificates.

usage instance-attribute

Specifies how this certificate is used. It can be used in the following ways:

  • SIGNING: For signing AS2 messages

  • ENCRYPTION: For encrypting AS2 messages

  • TLS: For securing AS2 communications sent over HTTPS