All URIs are relative to http://localhost/ejbca/ejbca-rest-api
| Method | HTTP request | Description |
|---|---|---|
| CertificateRequest | Post /v1/certificate/certificaterequest | Enrollment with client generated keys for an existing End Entity |
| EnrollKeystore | Post /v1/certificate/enrollkeystore | Keystore enrollment |
| EnrollPkcs10Certificate | Post /v1/certificate/pkcs10enroll | Enrollment with client generated keys, using CSR subject |
| FinalizeEnrollment | Post /v1/certificate/{request_id}/finalize | Finalize enrollment |
| GetCertificatesAboutToExpire | Get /v1/certificate/expire | Get a list of certificates that are about to expire |
| RevocationStatus | Get /v1/certificate/{issuer_dn}/{certificate_serial_number}/revocationstatus | Checks revocation status of the specified certificate |
| RevokeCertificate | Put /v1/certificate/{issuer_dn}/{certificate_serial_number}/revoke | Revokes the specified certificate |
| SearchCertificates | Post /v1/certificate/search | Searches for certificates confirming given criteria. |
| Status2 | Get /v1/certificate/status | Get the status of this REST Resource |
CertificateRestResponse CertificateRequest(ctx).CertificateRequestRestRequest(certificateRequestRestRequest).Execute()
Enrollment with client generated keys for an existing End Entity
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/Keyfactor/ejbca-go-client-sdk/api/ejbca"
)
func main() {
certificateRequestRestRequest := *openapiclient.NewCertificateRequestRestRequest() // CertificateRequestRestRequest | (optional)
authenticator, err := openapiclient.NewMTLSAuthenticatorBuilder().
WithClientCertificatePath("<path to client certificate>").
WithClientCertificateKeyPath("<path to client key>").
WithCaCertificatePath("<path to ca certificate>").
Build()
if err != nil {
panic(err)
}
configuration := openapiclient.NewConfiguration()
configuration.Host = "<hostname>:<optional port>"
configuration.SetAuthenticator(authenticator)
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CertificateApi.CertificateRequest(context.Background()).CertificateRequestRestRequest(certificateRequestRestRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CertificateApi.CertificateRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CertificateRequest`: CertificateRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CertificateApi.CertificateRequest`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCertificateRequestRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| certificateRequestRestRequest | CertificateRequestRestRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CertificateRestResponse EnrollKeystore(ctx).KeyStoreRestRequest(keyStoreRestRequest).Execute()
Keystore enrollment
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/Keyfactor/ejbca-go-client-sdk/api/ejbca"
)
func main() {
keyStoreRestRequest := *openapiclient.NewKeyStoreRestRequest() // KeyStoreRestRequest | (optional)
authenticator, err := openapiclient.NewMTLSAuthenticatorBuilder().
WithClientCertificatePath("<path to client certificate>").
WithClientCertificateKeyPath("<path to client key>").
WithCaCertificatePath("<path to ca certificate>").
Build()
if err != nil {
panic(err)
}
configuration := openapiclient.NewConfiguration()
configuration.Host = "<hostname>:<optional port>"
configuration.SetAuthenticator(authenticator)
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CertificateApi.EnrollKeystore(context.Background()).KeyStoreRestRequest(keyStoreRestRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CertificateApi.EnrollKeystore``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `EnrollKeystore`: CertificateRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CertificateApi.EnrollKeystore`: %v\n", resp)
}Other parameters are passed through a pointer to a apiEnrollKeystoreRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| keyStoreRestRequest | KeyStoreRestRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CertificateRestResponse EnrollPkcs10Certificate(ctx).EnrollCertificateRestRequest(enrollCertificateRestRequest).Execute()
Enrollment with client generated keys, using CSR subject
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/Keyfactor/ejbca-go-client-sdk/api/ejbca"
)
func main() {
enrollCertificateRestRequest := *openapiclient.NewEnrollCertificateRestRequest() // EnrollCertificateRestRequest | (optional)
authenticator, err := openapiclient.NewMTLSAuthenticatorBuilder().
WithClientCertificatePath("<path to client certificate>").
WithClientCertificateKeyPath("<path to client key>").
WithCaCertificatePath("<path to ca certificate>").
Build()
if err != nil {
panic(err)
}
configuration := openapiclient.NewConfiguration()
configuration.Host = "<hostname>:<optional port>"
configuration.SetAuthenticator(authenticator)
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CertificateApi.EnrollPkcs10Certificate(context.Background()).EnrollCertificateRestRequest(enrollCertificateRestRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CertificateApi.EnrollPkcs10Certificate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `EnrollPkcs10Certificate`: CertificateRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CertificateApi.EnrollPkcs10Certificate`: %v\n", resp)
}Other parameters are passed through a pointer to a apiEnrollPkcs10CertificateRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollCertificateRestRequest | EnrollCertificateRestRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CertificateRestResponse FinalizeEnrollment(ctx, requestId).FinalizeRestRequest(finalizeRestRequest).Execute()
Finalize enrollment
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/Keyfactor/ejbca-go-client-sdk/api/ejbca"
)
func main() {
requestId := int32(56) // int32 | Approval request id
finalizeRestRequest := *openapiclient.NewFinalizeRestRequest() // FinalizeRestRequest | responseFormat must be one of 'P12', 'BCFKS', 'JKS', 'DER' (optional)
authenticator, err := openapiclient.NewMTLSAuthenticatorBuilder().
WithClientCertificatePath("<path to client certificate>").
WithClientCertificateKeyPath("<path to client key>").
WithCaCertificatePath("<path to ca certificate>").
Build()
if err != nil {
panic(err)
}
configuration := openapiclient.NewConfiguration()
configuration.Host = "<hostname>:<optional port>"
configuration.SetAuthenticator(authenticator)
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CertificateApi.FinalizeEnrollment(context.Background(), requestId).FinalizeRestRequest(finalizeRestRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CertificateApi.FinalizeEnrollment``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `FinalizeEnrollment`: CertificateRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CertificateApi.FinalizeEnrollment`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| requestId | int32 | Approval request id |
Other parameters are passed through a pointer to a apiFinalizeEnrollmentRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
finalizeRestRequest | FinalizeRestRequest | responseFormat must be one of 'P12', 'BCFKS', 'JKS', 'DER' |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ExpiringCertificatesRestResponse GetCertificatesAboutToExpire(ctx).Days(days).Offset(offset).MaxNumberOfResults(maxNumberOfResults).Execute()
Get a list of certificates that are about to expire
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/Keyfactor/ejbca-go-client-sdk/api/ejbca"
)
func main() {
days := int64(789) // int64 | Request certificates expiring within this number of days (optional)
offset := int32(56) // int32 | Next offset to display results of, if maxNumberOfResults is exceeded. Starts from 0. (optional)
maxNumberOfResults := int32(56) // int32 | Maximum number of certificates to display. If result exceeds this value. Modify 'offset' to retrieve more results (optional)
authenticator, err := openapiclient.NewMTLSAuthenticatorBuilder().
WithClientCertificatePath("<path to client certificate>").
WithClientCertificateKeyPath("<path to client key>").
WithCaCertificatePath("<path to ca certificate>").
Build()
if err != nil {
panic(err)
}
configuration := openapiclient.NewConfiguration()
configuration.Host = "<hostname>:<optional port>"
configuration.SetAuthenticator(authenticator)
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CertificateApi.GetCertificatesAboutToExpire(context.Background()).Days(days).Offset(offset).MaxNumberOfResults(maxNumberOfResults).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CertificateApi.GetCertificatesAboutToExpire``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCertificatesAboutToExpire`: ExpiringCertificatesRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CertificateApi.GetCertificatesAboutToExpire`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetCertificatesAboutToExpireRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| days | int64 | Request certificates expiring within this number of days | |
| offset | int32 | Next offset to display results of, if maxNumberOfResults is exceeded. Starts from 0. | |
| maxNumberOfResults | int32 | Maximum number of certificates to display. If result exceeds this value. Modify 'offset' to retrieve more results |
ExpiringCertificatesRestResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RevokeStatusRestResponse RevocationStatus(ctx, issuerDn, certificateSerialNumber).Execute()
Checks revocation status of the specified certificate
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/Keyfactor/ejbca-go-client-sdk/api/ejbca"
)
func main() {
issuerDn := "issuerDn_example" // string | Subject DN of the issuing CA
certificateSerialNumber := "certificateSerialNumber_example" // string | hex serial number (without prefix, e.g. '00')
authenticator, err := openapiclient.NewMTLSAuthenticatorBuilder().
WithClientCertificatePath("<path to client certificate>").
WithClientCertificateKeyPath("<path to client key>").
WithCaCertificatePath("<path to ca certificate>").
Build()
if err != nil {
panic(err)
}
configuration := openapiclient.NewConfiguration()
configuration.Host = "<hostname>:<optional port>"
configuration.SetAuthenticator(authenticator)
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CertificateApi.RevocationStatus(context.Background(), issuerDn, certificateSerialNumber).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CertificateApi.RevocationStatus``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RevocationStatus`: RevokeStatusRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CertificateApi.RevocationStatus`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issuerDn | string | Subject DN of the issuing CA | |
| certificateSerialNumber | string | hex serial number (without prefix, e.g. '00') |
Other parameters are passed through a pointer to a apiRevocationStatusRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RevokeStatusRestResponse RevokeCertificate(ctx, issuerDn, certificateSerialNumber).Reason(reason).Date(date).Execute()
Revokes the specified certificate
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/Keyfactor/ejbca-go-client-sdk/api/ejbca"
)
func main() {
issuerDn := "issuerDn_example" // string | Subject DN of the issuing CA
certificateSerialNumber := "certificateSerialNumber_example" // string | hex serial number (without prefix, e.g. '00')
reason := "reason_example" // string | Must be valid RFC5280 reason. One of NOT_REVOKED, UNSPECIFIED ,KEY_COMPROMISE, CA_COMPROMISE, AFFILIATION_CHANGED, SUPERSEDED, CESSATION_OF_OPERATION, CERTIFICATE_HOLD, REMOVE_FROM_CRL, PRIVILEGES_WITHDRAWN, AA_COMPROMISE (optional)
date := time.Now() // time.Time | ISO 8601 Date string, eg. '2018-06-15T14:07:09Z' (optional)
authenticator, err := openapiclient.NewMTLSAuthenticatorBuilder().
WithClientCertificatePath("<path to client certificate>").
WithClientCertificateKeyPath("<path to client key>").
WithCaCertificatePath("<path to ca certificate>").
Build()
if err != nil {
panic(err)
}
configuration := openapiclient.NewConfiguration()
configuration.Host = "<hostname>:<optional port>"
configuration.SetAuthenticator(authenticator)
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CertificateApi.RevokeCertificate(context.Background(), issuerDn, certificateSerialNumber).Reason(reason).Date(date).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CertificateApi.RevokeCertificate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RevokeCertificate`: RevokeStatusRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CertificateApi.RevokeCertificate`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issuerDn | string | Subject DN of the issuing CA | |
| certificateSerialNumber | string | hex serial number (without prefix, e.g. '00') |
Other parameters are passed through a pointer to a apiRevokeCertificateRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
reason | string | Must be valid RFC5280 reason. One of NOT_REVOKED, UNSPECIFIED ,KEY_COMPROMISE, CA_COMPROMISE, AFFILIATION_CHANGED, SUPERSEDED, CESSATION_OF_OPERATION, CERTIFICATE_HOLD, REMOVE_FROM_CRL, PRIVILEGES_WITHDRAWN, AA_COMPROMISE | date | time.Time | ISO 8601 Date string, eg. '2018-06-15T14:07:09Z' |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SearchCertificatesRestResponse SearchCertificates(ctx).SearchCertificatesRestRequest(searchCertificatesRestRequest).Execute()
Searches for certificates confirming given criteria.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/Keyfactor/ejbca-go-client-sdk/api/ejbca"
)
func main() {
searchCertificatesRestRequest := *openapiclient.NewSearchCertificatesRestRequest() // SearchCertificatesRestRequest | Maximum number of results and collection of search criterias. (optional)
authenticator, err := openapiclient.NewMTLSAuthenticatorBuilder().
WithClientCertificatePath("<path to client certificate>").
WithClientCertificateKeyPath("<path to client key>").
WithCaCertificatePath("<path to ca certificate>").
Build()
if err != nil {
panic(err)
}
configuration := openapiclient.NewConfiguration()
configuration.Host = "<hostname>:<optional port>"
configuration.SetAuthenticator(authenticator)
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CertificateApi.SearchCertificates(context.Background()).SearchCertificatesRestRequest(searchCertificatesRestRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CertificateApi.SearchCertificates``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `SearchCertificates`: SearchCertificatesRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CertificateApi.SearchCertificates`: %v\n", resp)
}Other parameters are passed through a pointer to a apiSearchCertificatesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| searchCertificatesRestRequest | SearchCertificatesRestRequest | Maximum number of results and collection of search criterias. |
SearchCertificatesRestResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RestResourceStatusRestResponse Status2(ctx).Execute()
Get the status of this REST Resource
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/Keyfactor/ejbca-go-client-sdk/api/ejbca"
)
func main() {
authenticator, err := openapiclient.NewMTLSAuthenticatorBuilder().
WithClientCertificatePath("<path to client certificate>").
WithClientCertificateKeyPath("<path to client key>").
WithCaCertificatePath("<path to ca certificate>").
Build()
if err != nil {
panic(err)
}
configuration := openapiclient.NewConfiguration()
configuration.Host = "<hostname>:<optional port>"
configuration.SetAuthenticator(authenticator)
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CertificateApi.Status2(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CertificateApi.Status2``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `Status2`: RestResourceStatusRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CertificateApi.Status2`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiStatus2Request struct via the builder pattern
RestResourceStatusRestResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]