Type alias EnvCSR

EnvCSR: {
    createCSR(csr: CSR): Promise<CSRResponse>;
    createCSR2(algorithm: "rsa" | "ecdsa", businessCategory: string, city: string, commonName: string, country: string, email: string, jurisdictionCity: string, jurisdictionCountry: string, jurisdictionState: string, organization: string, organizationalUnit: string, postalCode: string, serialNumber: string, state: string, streetAddress: string, subjectAlternativeNames: string[]): Promise<CSRResponse>;
    deleteCSR(csrId: string): Promise<CSRResponse>;
    deleteCSRs(): Promise<CSRResponse[]>;
    readCSR(csrId: string): Promise<CSRResponse>;
    readCSRs(): Promise<CSRResponse[]>;
    updateCSR(csrId: string, certificate: string): Promise<CSRResponse>;
}

Type declaration

  • createCSR:function
  • createCSR2:function
    • createCSR2(algorithm: "rsa" | "ecdsa", businessCategory: string, city: string, commonName: string, country: string, email: string, jurisdictionCity: string, jurisdictionCountry: string, jurisdictionState: string, organization: string, organizationalUnit: string, postalCode: string, serialNumber: string, state: string, streetAddress: string, subjectAlternativeNames: string[]): Promise<CSRResponse>

    • Create CSR

      Parameters

      • algorithm: "rsa" | "ecdsa"

        The algorithm for the private key. The encryption algorithm will either be RSA-2048 or ECDSA P-256 depending on the algorithm choice. The default is RSA-2048.

      • businessCategory: string

        Category of business, such as "Private Organization", “Government Entity”, “Business Entity”, or “Non-Commercial Entity”. Relevant for EV certificates.

      • city: string

        City

      • commonName: string

        Domain name that the SSL certificate is securing

      • country: string

        Two-letter ISO-3166 country code: string[A-Z]{2}

      • email: string

        Email: string^\S+@\S+$

      • jurisdictionCity: string

        This field contains only information relevant to the Jurisdiction of Incorporation or Registration. Relevant for EV certificates.

      • jurisdictionCountry: string

        This field contains only information relevant to the Jurisdiction of Incorporation or Registration. Relevant for EV certificates.

      • jurisdictionState: string

        This field contains only information relevant to the Jurisdiction of Incorporation or Registration. Relevant for EV certificates.

      • organization: string

        Full name of company

      • organizationalUnit: string

        Company section or department

      • postalCode: string

        Zip code

      • serialNumber: string

        The Registration (or similar) Number assigned to the Subject by the Incorporating or Registration Agency in its Jurisdiction of Incorporation or Registration. Relevant for EV certificates.

      • state: string

        State

      • streetAddress: string

        Address

      • subjectAlternativeNames: string[]

        Additional domain or domains that the SSL certificate is securing

      Returns Promise<CSRResponse>

      a promise that resolves to a CSRResponse object

  • deleteCSR:function
  • deleteCSRs:function
  • readCSR:function
  • readCSRs:function
  • updateCSR:function
    • updateCSR(csrId: string, certificate: string): Promise<CSRResponse>

    • Update CSR

      Parameters

      • csrId: string

        ID of the CSR

      • certificate: string

        The matching signed certificate for the request. This should only be set on update requests to upload the certificate.

      Returns Promise<CSRResponse>

      a promise that resolves to a CSRResponse object

Settings

Member Visibility

Theme