CreatePKICertIssuer.md

Akeyless::CreatePKICertIssuer

Properties

Name	Type	Description	Notes
allow_any_name	Boolean	If set, clients can request certificates for any CN	[optional]
allow_copy_ext_from_csr	Boolean	If set, will allow copying the extra extensions from the csr file (if given)	[optional]
allow_subdomains	Boolean	If set, clients can request certificates for subdomains and wildcard subdomains of the allowed domains	[optional]
allowed_domains	String	A list of the allowed domains that clients can request to be included in the certificate (in a comma-delimited list)	[optional]
allowed_extra_extensions	String	A json string containing the allowed extra extensions for the pki cert issuer	[optional]
allowed_uri_sans	String	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)	[optional]
auto_renew	Boolean	Automatically renew certificates before expiration	[optional]
ca_target	String	The name of an existing CA target to attach this PKI Certificate Issuer to, required in Public CA mode	[optional]
client_flag	Boolean	If set, certificates will be flagged for client auth use	[optional]
code_signing_flag	Boolean	If set, certificates will be flagged for code signing use	[optional]
country	String	A comma-separated list of countries that will be set in the issued certificate	[optional]
create_private_crl	Boolean	Set this to allow the issuer will expose a CRL endpoint in the Gateway	[optional]
create_public_crl	Boolean	Set this to allow the cert issuer will expose a public CRL endpoint	[optional]
critical_key_usage	String	Mark key usage as critical [true/false]	[optional][default to 'true']
delete_protection	String	Protection from accidental deletion of this object [true/false]	[optional]
description	String	Description of the object	[optional]
destination_path	String	A path in which to save generated certificates	[optional]
enable_acme	Boolean	If set, the cert issuer will support the acme protocol	[optional]
expiration_event_in	Array<String>	How many days before the expiration of the certificate would you like to be notified.	[optional]
gw_cluster_url	String	The GW cluster URL to issue the certificate from. Required in Public CA mode, to allow CRLs on private CA, or to enable ACME	[optional]
is_ca	Boolean	If set, the basic constraints extension will be added to certificate	[optional]
json	Boolean	Set output format to JSON	[optional][default to false]
key_usage	String	key-usage	[optional][default to 'DigitalSignature,KeyAgreement,KeyEncipherment']
locality	String	A comma-separated list of localities that will be set in the issued certificate	[optional]
metadata	String	Deprecated - use description	[optional]
name	String	PKI certificate issuer name
not_enforce_hostnames	Boolean	If set, any names are allowed for CN and SANs in the certificate and not only a valid host name	[optional]
not_require_cn	Boolean	If set, clients can request certificates without a CN	[optional]
organizational_units	String	A comma-separated list of organizational units (OU) that will be set in the issued certificate	[optional]
organizations	String	A comma-separated list of organizations (O) that will be set in the issued certificate	[optional]
postal_code	String	A comma-separated list of postal codes that will be set in the issued certificate	[optional]
protect_certificates	Boolean	Whether to protect generated certificates from deletion	[optional]
province	String	A comma-separated list of provinces that will be set in the issued certificate	[optional]
scheduled_renew	Integer	Number of days before expiration to renew certificates	[optional]
server_flag	Boolean	If set, certificates will be flagged for server auth use	[optional]
signer_key_name	String	A key to sign the certificate with, required in Private CA mode	[default to 'dummy_signer_key']
street_address	String	A comma-separated list of street addresses that will be set in the issued certificate	[optional]
tag	Array<String>	List of the tags attached to this key	[optional]
token	String	Authentication token (see `/auth` and `/configure`)	[optional]
ttl	String	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
uid_token	String	The universal identity token, Required only for universal_identity authentication	[optional]

Example

require 'akeyless'

instance = Akeyless::CreatePKICertIssuer.new(
  allow_any_name: null,
  allow_copy_ext_from_csr: null,
  allow_subdomains: null,
  allowed_domains: null,
  allowed_extra_extensions: null,
  allowed_uri_sans: null,
  auto_renew: null,
  ca_target: null,
  client_flag: null,
  code_signing_flag: null,
  country: null,
  create_private_crl: null,
  create_public_crl: null,
  critical_key_usage: null,
  delete_protection: null,
  description: null,
  destination_path: null,
  enable_acme: null,
  expiration_event_in: null,
  gw_cluster_url: null,
  is_ca: null,
  json: null,
  key_usage: null,
  locality: null,
  metadata: null,
  name: null,
  not_enforce_hostnames: null,
  not_require_cn: null,
  organizational_units: null,
  organizations: null,
  postal_code: null,
  protect_certificates: null,
  province: null,
  scheduled_renew: null,
  server_flag: null,
  signer_key_name: null,
  street_address: null,
  tag: null,
  token: null,
  ttl: null,
  uid_token: null
)