Skip to content

Latest commit

 

History

History
102 lines (73 loc) · 4.66 KB

api.md

File metadata and controls

102 lines (73 loc) · 4.66 KB

# API Docs This Document documents the types introduced by the DigiCert Issuer to be consumed by users. > Note this document is generated from code comments. When contributing a change to this document please do so by changing the code comments.

Table of Contents

DigicertIssuer

DigicertIssuer is the Schema for the digicertissuers API

Field Description Scheme Required
metadata metav1.ObjectMeta false
spec DigicertIssuerSpec true
status *DigicertIssuerStatus false

Back to TOC

DigicertIssuerCondition

DigicertIssuerCondition ...

Field Description Scheme Required
type Type of the condition, currently ('Ready'). ConditionType true
status Status of the condition, one of ('True', 'False', 'Unknown'). ConditionStatus true
lastTransitionTime LastTransitionTime is the timestamp corresponding to the last status change of this condition. *metav1.Time false
reason Reason is a brief machine readable explanation for the condition's last transition. ConditionReason false
message Message is a human readable description of the details of the last transition, complementing reason. string false

Back to TOC

DigicertIssuerList

DigicertIssuerList contains a list of DigicertIssuer

Field Description Scheme Required
metadata metav1.ListMeta false
items []DigicertIssuer true

Back to TOC

DigicertIssuerSpec

DigicertIssuerSpec defines the desired state of DigicertIssuer

Field Description Scheme Required
url Optional URL is the DigiCert cert-central API. string false
provisioner Provisioner contains the DigiCert provisioner configuration. DigicertProvisioner true

Back to TOC

DigicertIssuerStatus

DigicertIssuerStatus defines the observed state of DigicertIssuer

Field Description Scheme Required
conditions Conditions is a list of DigicertIssuerConditions describing the current status. []DigicertIssuerCondition false

Back to TOC

DigicertProvisioner

DigiCertProvisioner contains the DigiCert provisioner configuration.

Field Description Scheme Required
apiTokenReference APITokenReference references a secret in the same namespace containing the DigiCert API token. SecretKeySelector true
caCertID CACertID is the ID of the CA if multiple CA certificates are configured in the (sub-)account. string false
organizationID OrganizationID is the ID of the organization in Digicert. *int false
organizationName OrganizationName is the name of the organization in Digicert. If specified takes precedence over OrganizationID. string false
organizationUnits OrganizationUnits is the list of organizational units. []string false
validityYears ValidityYears is the validity of the certificate in years. *int false
disableRenewalNotifications DisableRenewalNotifications disables email renewal notifications for expiring certificates. *bool false
paymentMethod PaymentMethod is the configured payment method in the Digicert account. string false
skipApproval SkipApproval skips the approval of the certificate. *bool false
orderType OrderType is the certificate order type. string false
containerID ContainerID is the ID of the division *int false

Back to TOC

SecretKeySelector

SecretKeySelector references a secret in the same namespace containing sensitive configuration.

Field Description Scheme Required
name The name of the secret. string true
key The key in the secret. string true

Back to TOC