Package com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2.model

Class ConfigurationActionPrototype

    • Method Detail

      • actionType

        public String actionType()
        Gets the actionType. The type of configuration action.
        Returns:
        the actionType

      • commonName

        public String commonName()
        Gets the commonName. The Common Name (CN) represents the server name that is protected by the SSL certificate.
        Returns:
        the commonName

      • altNames

        public List<String> altNames()
        Gets the altNames. With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL certificate.
        Returns:
        the altNames

      • ipSans

        public String ipSans()
        Gets the ipSans. The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
        Returns:
        the ipSans

      • uriSans

        public String uriSans()
        Gets the uriSans. The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
        Returns:
        the uriSans

      • otherSans

        public List<String> otherSans()
        Gets the otherSans. The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate. The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is `UTF8`.
        Returns:
        the otherSans

      • ttl

        public String ttl()
        Gets the ttl. The time-to-live (TTL) to assign to a private certificate. The value can be supplied as a string representation of a duration in hours, for example '12h'. The value can't exceed the `max_ttl` that is defined in the associated certificate template.
        Returns:
        the ttl

      • format

        public String format()
        Gets the format. The format of the returned data.
        Returns:
        the format

      • maxPathLength

        public Long maxPathLength()
        Gets the maxPathLength. The maximum path length to encode in the generated certificate. `-1` means no limit. If the signing certificate has a maximum path length set, the path length is set to one less than that of the signing certificate. A limit of `0` means a literal path length of zero.
        Returns:
        the maxPathLength

      • excludeCnFromSans

        public Boolean excludeCnFromSans()
        Gets the excludeCnFromSans. This parameter controls whether the common name is excluded from Subject Alternative Names (SANs). If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.
        Returns:
        the excludeCnFromSans

      • permittedDnsDomains

        public List<String> permittedDnsDomains()
        Gets the permittedDnsDomains. The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.
        Returns:
        the permittedDnsDomains

      • useCsrValues

        public Boolean useCsrValues()
        Gets the useCsrValues. This field indicates whether to use values from a certificate signing request (CSR) to complete a `private_cert_configuration_action_sign_csr` action. If it is set to `true`, then: 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the values that are provided in the other parameters to this operation. 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key usages used for CA certificates that are signed by the intermediate authority. 3) Extensions that are requested in the CSR are copied into the issued private certificate.
        Returns:
        the useCsrValues

      • ou

        public List<String> ou()
        Gets the ou. The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
        Returns:
        the ou

      • organization

        public List<String> organization()
        Gets the organization. The Organization (O) values to define in the subject field of the resulting certificate.
        Returns:
        the organization

      • country

        public List<String> country()
        Gets the country. The Country (C) values to define in the subject field of the resulting certificate.
        Returns:
        the country

      • locality

        public List<String> locality()
        Gets the locality. The Locality (L) values to define in the subject field of the resulting certificate.
        Returns:
        the locality

      • province

        public List<String> province()
        Gets the province. The Province (ST) values to define in the subject field of the resulting certificate.
        Returns:
        the province

      • streetAddress

        public List<String> streetAddress()
        Gets the streetAddress. The street address values to define in the subject field of the resulting certificate.
        Returns:
        the streetAddress

      • postalCode

        public List<String> postalCode()
        Gets the postalCode. The postal code values to define in the subject field of the resulting certificate.
        Returns:
        the postalCode

      • serialNumber

        public String serialNumber()
        Gets the serialNumber. The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute that is in the certificate's distinguished name (DN). **Note:** This field is not related to the `serial_number` field that is returned in the API response. The `serial_number` field represents the certificate's randomly assigned serial number.
        Returns:
        the serialNumber

      • csr

        public String csr()
        Gets the csr. The certificate signing request.
        Returns:
        the csr

      • intermediateCertificateAuthority

        public String intermediateCertificateAuthority()
        Gets the intermediateCertificateAuthority. The name of the intermediate certificate authority configuration.
        Returns:
        the intermediateCertificateAuthority

      • certificate

        public String certificate()
        Gets the certificate. Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
        Returns:
        the certificate