Certificates

POST /update-pki-cert-issuer

Changed on

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/update-pki-cert-issuer
  • Auth
    none declared

Request body

add-tagstring[]

List of the new tags that will be attached to this item

allow-any-nameboolean

If set, clients can request certificates for any CN

allow-copy-ext-from-csrboolean

If set, will allow copying the extra extensions from the csr file (if given)

allow-subdomainsboolean

If set, clients can request certificates for subdomains of the allowed domains

allowed-domainsstring

A list of the allowed domains that clients can request to be included in the certificate (in a comma-delimited list)

allowed-extra-extensionsstring

A json string containing the allowed extra extensions for the pki cert issuer

allowed-ip-sansstring

A list of the allowed CIDRs for ips that clients can request to be included in the certificate as part of the IP Subject Alternative Names (in a comma-delimited list)

allowed-uri-sansstring

A list of the allowed URIs that clients can request to be included in the certificate as part of the URI Subject Alternative Names (in a comma-delimited list)

auto-renewboolean

Automatically renew certificates before expiration

basic-constraintsstring

Defines the X.509 Basic Constraints extension for certificates issued by this PKI issuer template

client-flagboolean

If set, certificates will be flagged for client auth use

code-signing-flagboolean

If set, certificates will be flagged for code signing use

countrystring

A comma-separated list of countries that will be set in the issued certificate

create-private-crlboolean

Set this to allow the issuer will expose a CRL endpoint in the Gateway

create-private-ocspboolean

Set this to enable an OCSP endpoint in the Gateway and include its URL in AIA

create-public-crlboolean

Set this to allow the cert issuer will expose a public CRL endpoint

create-public-ocspboolean

Set this to enable a public OCSP endpoint and include its URL in AIA (served by UAM and includes account id)

critical-key-usagestring

Mark key usage as critical [true/false]

delete_protectionstring

Protection from accidental deletion of this object [true/false]

descriptionstring

Description of the object

destination-pathstring

A path in which to save generated certificates

disable-wildcardsboolean

If set, generation of wildcard certificates will be disabled.

enable-acmeboolean

If set, the cert issuer will support the acme protocol

enable-scepboolean

If set, the cert issuer will support the scep protocol

expiration-event-instring[]

How many days before the expiration of the certificate would you like to be notified.

gw-cluster-urlstring

The GW cluster URL to issue the certificate from. Required in Public CA mode, to allow CRLs on private CA, or to enable ACME

is-caboolean

If set, the basic constraints extension will be added to certificate

item-custom-fieldsobject

Additional custom fields to associate with the item

jsonboolean

Set output format to JSON

key-usagestring

key-usage

localitystring

A comma-separated list of localities that will be set in the issued certificate

max-path-leninteger

The maximum path length for the generated certificate. -1, means unlimited

metadatastring

Deprecated - use description

namestring required

PKI certificate issuer name

new-namestring

New item name

not-enforce-hostnamesboolean

If set, any names are allowed for CN and SANs in the certificate and not only a valid host name

not-require-cnboolean

If set, clients can request certificates without a CN

ocsp-ttlstring

OCSP NextUpdate window for OCSP responses (min 10m). Supports s,m,h,d suffix.

organizational-unitsstring

A comma-separated list of organizational units (OU) that will be set in the issued certificate

organizationsstring

A comma-separated list of organizations (O) that will be set in the issued certificate

postal-codestring

A comma-separated list of postal codes that will be set in the issued certificate

protect-certificatesboolean

Whether to protect generated certificates from deletion

provincestring

A comma-separated list of provinces that will be set in the issued certificate

rm-tagstring[]

List of the existent tags that will be removed from this item

scep-challenge-typestring

SCEP challenge type. Only static is supported in this stage

scep-passwordstring

SCEP static challenge password. Request-only; never returned by Describe

scheduled-renewinteger

Number of days before expiration to renew certificates

server-flagboolean

If set, certificates will be flagged for server auth use

signer-key-namestring

A key to sign the certificate with, required in Private CA mode

split-certificate-chainboolean

If set, separates the leaf certificate from the certificate chain.

street-addressstring

A comma-separated list of street addresses that will be set in the issued certificate

tokenstring

Authentication token (see /auth and /configure)

ttlstring required

The maximum requested Time To Live for issued certificates, in seconds. In case of Public CA, this is based on the CA target's supported maximum TTLs. Not supported for Let's Encrypt, which always uses the CA default lifetime (about 90 days).

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

Response

updatePKICertIssuerResponse wraps response body.

namestring

Changes

    • info

      api tag Certificates added

    • info

      api tag v2 removed

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property