# CertificateSigningRequest

CertificateSigningRequestCertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued.apiVersion: certificates.k8s.io/v1import "k8s.io/api/certificates/v1"CertificateSigningRequestCertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued.Kubelets use this API to obtain:client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client-kubelet" signerName).serving certificates for TLS endpoints kube-apiserver can connect to securely (with the "kubernetes.io/kubelet-serving" signerName).This API can be used to request client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client" signerName), or to obtain certificates from custom non-Kubernetes signers.apiVersion: certificates.k8s.io/v1kind: CertificateSigningRequestmetadata (ObjectMeta)spec (CertificateSigningRequestSpec), requiredspec contains the certificate request, and is immutable after creation. Only the request, signerName, expirationSeconds, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users.status (CertificateSigningRequestStatus)status contains information about whether the request is approved or denied, and the certificate issued by the signer, or the failure condition indicating signer failure.CertificateSigningRequestSpecCertificateSigningRequestSpec contains the certificate request.request ([]byte), requiredAtomic: will be replaced during a mergerequest contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded.signerName (string), requiredsignerName indicates the requested signer, and is a qualified name.List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector.Well-known Kubernetes signers are:"kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver. Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager."kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver. Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager."kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely. Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager.More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signersCustom signerNames can also be specified. The signer defines:Trust distribution: how trust (CA bundles) are distributed.Permitted subjects: and behavior when a disallowed subject is requested.Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested.Required, permitted, or forbidden key usages / extended key usages.Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin.Whether or not requests for CA certificates are allowed.expirationSeconds (int32)expirationSeconds is the requested duration of validity of the issued certificate. The certificate signer may issue a certificate with a different validity duration so a client must check the delta between the notBefore and and notAfter fields in the issued certificate to determine the actual duration.The v1.22+ in-tree implementations of the well-known Kubernetes signers will honor this field as long as the requested duration is not greater than the maximum duration they will honor per the --cluster-signing-duration CLI flag to the Kubernetes controller manager.Certificate signers may not honor this field for various reasons:Old signer that is unaware of the field (such as the in-tree implementations prior to v1.22)Signer whose configured maximum is shorter than the requested durationSigner whose configured minimum is longer than the requested durationThe minimum valid value for expirationSeconds is 600, i.e. 10 minutes.extra (map[string][]string)extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.groups ([]string)Atomic: will be replaced during a mergegroups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.uid (string)uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.usages ([]string)Atomic: will be replaced during a mergeusages specifies a set of key usages requested in the issued certificate.Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth".Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth".Valid values are: "signing", "digital signature", "content commitment", "key encipherment", "key agreement", "data encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "email protection", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc"username (string)username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.CertificateSigningRequestStatusCertificateSigningRequestStatus contains conditions used to indicate approved/denied/failed status of the request, and the issued certificate.certificate ([]byte)Atomic: will be replaced during a mergecertificate is populated with an issued certificate by the signer after an Approved condition is present. This field is set via the /status subresource. Once populated, this field is immutable.If the certificate signing request is denied, a condition of type "Denied" is added and this field remains empty. If the signer cannot issue the certificate, a condition of type "Failed" is added and this field remains empty.Validation requirements:certificate must contain one or more PEM blocks.All PEM blocks must have the "CERTIFICATE" label, contain no headers, and the encoded data must be a BER-encoded ASN.1 Certificate structure as described in section 4 of RFC5280.Non-PEM content may appear before or after the "CERTIFICATE" PEM blocks and is unvalidated, to allow for explanatory text as described in section 5.2 of RFC7468.If more than one PEM block is present, and the definition of the requested spec.signerName does not indicate otherwise, the first block is the issued certificate, and subsequent blocks should be treated as intermediate certificates and presented in TLS handshakes.The certificate is encoded in PEM format.When serialized as JSON or YAML, the data is additionally base64-encoded, so it consists of:base64( -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- ) conditions ([]CertificateSigningRequestCondition)Map: unique values on key type will be kept during a mergeconditions applied to the request. Known conditions are "Approved", "Denied", and "Failed".CertificateSigningRequestCondition describes a condition of a CertificateSigningRequest objectconditions.status (string), requiredstatus of the condition, one of True, False, Unknown. Approved, Denied, and Failed conditions may not be "False" or "Unknown".conditions.type (string), requiredtype of the condition. Known conditions are "Approved", "Denied", and "Failed".An "Approved" condition is added via the /approval subresource, indicating the request was approved and should be issued by the signer.A "Denied" condition is added via the /approval subresource, indicating the request was denied and should not be issued by the signer.A "Failed" condition is added via the /status subresource, indicating the signer failed to issue the certificate.Approved and Denied conditions are mutually exclusive. Approved, Denied, and Failed conditions cannot be removed once added.Only one condition of a given type is allowed.conditions.lastTransitionTime (Time)lastTransitionTime is the time the condition last transitioned from one status to another. If unset, when a new condition type is added or an existing condition's status is changed, the server defaults this to the current time.Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.conditions.lastUpdateTime (Time)lastUpdateTime is the time of the last update to this conditionTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.conditions.message (string)message contains a human readable message with details about the request stateconditions.reason (string)reason indicates a brief reason for the request stateCertificateSigningRequestListCertificateSigningRequestList is a collection of CertificateSigningRequest objectsapiVersion: certificates.k8s.io/v1kind: CertificateSigningRequestListmetadata (ListMeta)items ([]CertificateSigningRequest), requireditems is a collection of CertificateSigningRequest objectsOperationsget read the specified CertificateSigningRequestHTTP RequestGET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}Parametersname (in path): string, requiredname of the CertificateSigningRequestpretty (in query): stringprettyResponse200 (CertificateSigningRequest): OK401: Unauthorizedget read approval of the specified CertificateSigningRequestHTTP RequestGET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approvalParametersname (in path): string, requiredname of the CertificateSigningRequestpretty (in query): stringprettyResponse200 (CertificateSigningRequest): OK401: Unauthorizedget read status of the specified CertificateSigningRequestHTTP RequestGET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/statusParametersname (in path): string, requiredname of the CertificateSigningRequestpretty (in query): stringprettyResponse200 (CertificateSigningRequest): OK401: Unauthorizedlist list or watch objects of kind CertificateSigningRequestHTTP RequestGET /apis/certificates.k8s.io/v1/certificatesigningrequestsParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (CertificateSigningRequestList): OK401: Unauthorizedcreate create a CertificateSigningRequestHTTP RequestPOST /apis/certificates.k8s.io/v1/certificatesigningrequestsParametersbody: CertificateSigningRequest, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CertificateSigningRequest): OK201 (CertificateSigningRequest): Created202 (CertificateSigningRequest): Accepted401: Unauthorizedupdate replace the specified CertificateSigningRequestHTTP RequestPUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}Parametersname (in path): string, requiredname of the CertificateSigningRequestbody: CertificateSigningRequest, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CertificateSigningRequest): OK201 (CertificateSigningRequest): Created401: Unauthorizedupdate replace approval of the specified CertificateSigningRequestHTTP RequestPUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approvalParametersname (in path): string, requiredname of the CertificateSigningRequestbody: CertificateSigningRequest, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CertificateSigningRequest): OK201 (CertificateSigningRequest): Created401: Unauthorizedupdate replace status of the specified CertificateSigningRequestHTTP RequestPUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/statusParametersname (in path): string, requiredname of the CertificateSigningRequestbody: CertificateSigningRequest, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CertificateSigningRequest): OK201 (CertificateSigningRequest): Created401: Unauthorizedpatch partially update the specified CertificateSigningRequestHTTP RequestPATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}Parametersname (in path): string, requiredname of the CertificateSigningRequestbody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (CertificateSigningRequest): OK201 (CertificateSigningRequest): Created401: Unauthorizedpatch partially update approval of the specified CertificateSigningRequestHTTP RequestPATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approvalParametersname (in path): string, requiredname of the CertificateSigningRequestbody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (CertificateSigningRequest): OK201 (CertificateSigningRequest): Created401: Unauthorizedpatch partially update status of the specified CertificateSigningRequestHTTP RequestPATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/statusParametersname (in path): string, requiredname of the CertificateSigningRequestbody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (CertificateSigningRequest): OK201 (CertificateSigningRequest): Created401: Unauthorizeddelete delete a CertificateSigningRequestHTTP RequestDELETE /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}Parametersname (in path): string, requiredname of the CertificateSigningRequestbody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of CertificateSigningRequestHTTP RequestDELETE /apis/certificates.k8s.io/v1/certificatesigningrequestsParametersbody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.