client_certificates

package
v2.0.0-beta.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 11, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClientCertificateDeleteParams 

type ClientCertificateDeleteParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ClientCertificateDeleteResponseEnvelope 

type ClientCertificateDeleteResponseEnvelope struct {
	Errors   []ClientCertificateDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ClientCertificateDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesClientCertificate      `json:"result,required"`
	// Whether the API call was successful
	Success ClientCertificateDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    clientCertificateDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ClientCertificateDeleteResponseEnvelope) UnmarshalJSON 

func (r *ClientCertificateDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ClientCertificateDeleteResponseEnvelopeErrors 

type ClientCertificateDeleteResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    clientCertificateDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ClientCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *ClientCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ClientCertificateDeleteResponseEnvelopeMessages 

type ClientCertificateDeleteResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    clientCertificateDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ClientCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *ClientCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ClientCertificateDeleteResponseEnvelopeSuccess 

type ClientCertificateDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ClientCertificateDeleteResponseEnvelopeSuccessTrue ClientCertificateDeleteResponseEnvelopeSuccess = true
)

type ClientCertificateEditParams 

type ClientCertificateEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ClientCertificateEditResponseEnvelope 

type ClientCertificateEditResponseEnvelope struct {
	Errors   []ClientCertificateEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ClientCertificateEditResponseEnvelopeMessages `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesClientCertificate    `json:"result,required"`
	// Whether the API call was successful
	Success ClientCertificateEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    clientCertificateEditResponseEnvelopeJSON    `json:"-"`
}

func (*ClientCertificateEditResponseEnvelope) UnmarshalJSON 

func (r *ClientCertificateEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ClientCertificateEditResponseEnvelopeErrors 

type ClientCertificateEditResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    clientCertificateEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ClientCertificateEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *ClientCertificateEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ClientCertificateEditResponseEnvelopeMessages 

type ClientCertificateEditResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    clientCertificateEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ClientCertificateEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *ClientCertificateEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ClientCertificateEditResponseEnvelopeSuccess 

type ClientCertificateEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ClientCertificateEditResponseEnvelopeSuccessTrue ClientCertificateEditResponseEnvelopeSuccess = true
)

type ClientCertificateGetParams 

type ClientCertificateGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ClientCertificateGetResponseEnvelope 

type ClientCertificateGetResponseEnvelope struct {
	Errors   []ClientCertificateGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ClientCertificateGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesClientCertificate   `json:"result,required"`
	// Whether the API call was successful
	Success ClientCertificateGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    clientCertificateGetResponseEnvelopeJSON    `json:"-"`
}

func (*ClientCertificateGetResponseEnvelope) UnmarshalJSON 

func (r *ClientCertificateGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ClientCertificateGetResponseEnvelopeErrors 

type ClientCertificateGetResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    clientCertificateGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ClientCertificateGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *ClientCertificateGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ClientCertificateGetResponseEnvelopeMessages 

type ClientCertificateGetResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    clientCertificateGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ClientCertificateGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *ClientCertificateGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ClientCertificateGetResponseEnvelopeSuccess 

type ClientCertificateGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ClientCertificateGetResponseEnvelopeSuccessTrue ClientCertificateGetResponseEnvelopeSuccess = true
)

type ClientCertificateListParams 

type ClientCertificateListParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Limit to the number of records returned.
	Limit param.Field[int64] `query:"limit"`
	// Offset the results
	Offset param.Field[int64] `query:"offset"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Number of records per page.
	PerPage param.Field[float64] `query:"per_page"`
	// Client Certitifcate Status to filter results by.
	Status param.Field[ClientCertificateListParamsStatus] `query:"status"`
}

func (ClientCertificateListParams) URLQuery 

func (r ClientCertificateListParams) URLQuery() (v url.Values)

URLQuery serializes ClientCertificateListParams's query parameters as `url.Values`.

type ClientCertificateListParamsStatus 

type ClientCertificateListParamsStatus string

Client Certitifcate Status to filter results by. 

const (
	ClientCertificateListParamsStatusAll                 ClientCertificateListParamsStatus = "all"
	ClientCertificateListParamsStatusActive              ClientCertificateListParamsStatus = "active"
	ClientCertificateListParamsStatusPendingReactivation ClientCertificateListParamsStatus = "pending_reactivation"
	ClientCertificateListParamsStatusPendingRevocation   ClientCertificateListParamsStatus = "pending_revocation"
	ClientCertificateListParamsStatusRevoked             ClientCertificateListParamsStatus = "revoked"
)

type ClientCertificateNewParams 

type ClientCertificateNewParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The Certificate Signing Request (CSR). Must be newline-encoded.
	Csr param.Field[string] `json:"csr,required"`
	// The number of days the Client Certificate will be valid after the issued_on date
	ValidityDays param.Field[int64] `json:"validity_days,required"`
}

func (ClientCertificateNewParams) MarshalJSON 

func (r ClientCertificateNewParams) MarshalJSON() (data []byte, err error)

type ClientCertificateNewResponseEnvelope 

type ClientCertificateNewResponseEnvelope struct {
	Errors   []ClientCertificateNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ClientCertificateNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesClientCertificate   `json:"result,required"`
	// Whether the API call was successful
	Success ClientCertificateNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    clientCertificateNewResponseEnvelopeJSON    `json:"-"`
}

func (*ClientCertificateNewResponseEnvelope) UnmarshalJSON 

func (r *ClientCertificateNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ClientCertificateNewResponseEnvelopeErrors 

type ClientCertificateNewResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    clientCertificateNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ClientCertificateNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *ClientCertificateNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ClientCertificateNewResponseEnvelopeMessages 

type ClientCertificateNewResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    clientCertificateNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ClientCertificateNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *ClientCertificateNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ClientCertificateNewResponseEnvelopeSuccess 

type ClientCertificateNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ClientCertificateNewResponseEnvelopeSuccessTrue ClientCertificateNewResponseEnvelopeSuccess = true
)

type ClientCertificateService 

type ClientCertificateService struct {
	Options []option.RequestOption
}

ClientCertificateService contains methods and other services that help with interacting with the cloudflare API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewClientCertificateService method instead.

func NewClientCertificateService 

func NewClientCertificateService(opts ...option.RequestOption) (r *ClientCertificateService)

NewClientCertificateService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ClientCertificateService) Delete 

func (r *ClientCertificateService) Delete(ctx context.Context, clientCertificateID string, body ClientCertificateDeleteParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesClientCertificate, err error)

Set a API Shield mTLS Client Certificate to pending_revocation status for processing to revoked status.

func (*ClientCertificateService) Edit 

func (r *ClientCertificateService) Edit(ctx context.Context, clientCertificateID string, body ClientCertificateEditParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesClientCertificate, err error)

If a API Shield mTLS Client Certificate is in a pending_revocation state, you may reactivate it with this endpoint.

func (*ClientCertificateService) Get 

func (r *ClientCertificateService) Get(ctx context.Context, clientCertificateID string, query ClientCertificateGetParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesClientCertificate, err error)

Get Details for a single mTLS API Shield Client Certificate

func (*ClientCertificateService) List 

func (r *ClientCertificateService) List(ctx context.Context, params ClientCertificateListParams, opts ...option.RequestOption) (res *shared.V4PagePaginationArray[TLSCertificatesAndHostnamesClientCertificate], err error)

List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination

func (*ClientCertificateService) ListAutoPaging 

func (r *ClientCertificateService) ListAutoPaging(ctx context.Context, params ClientCertificateListParams, opts ...option.RequestOption) *shared.V4PagePaginationArrayAutoPager[TLSCertificatesAndHostnamesClientCertificate]

List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination

func (*ClientCertificateService) New 

func (r *ClientCertificateService) New(ctx context.Context, params ClientCertificateNewParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesClientCertificate, err error)

Create a new API Shield mTLS Client Certificate

type Error 

type Error = apierror.Error

type TLSCertificatesAndHostnamesClientCertificate 

type TLSCertificatesAndHostnamesClientCertificate struct {
	// Identifier
	ID string `json:"id"`
	// The Client Certificate PEM
	Certificate string `json:"certificate"`
	// Certificate Authority used to issue the Client Certificate
	CertificateAuthority TLSCertificatesAndHostnamesClientCertificateCertificateAuthority `json:"certificate_authority"`
	// Common Name of the Client Certificate
	CommonName string `json:"common_name"`
	// Country, provided by the CSR
	Country string `json:"country"`
	// The Certificate Signing Request (CSR). Must be newline-encoded.
	Csr string `json:"csr"`
	// Date that the Client Certificate expires
	ExpiresOn string `json:"expires_on"`
	// Unique identifier of the Client Certificate
	FingerprintSha256 string `json:"fingerprint_sha256"`
	// Date that the Client Certificate was issued by the Certificate Authority
	IssuedOn string `json:"issued_on"`
	// Location, provided by the CSR
	Location string `json:"location"`
	// Organization, provided by the CSR
	Organization string `json:"organization"`
	// Organizational Unit, provided by the CSR
	OrganizationalUnit string `json:"organizational_unit"`
	// The serial number on the created Client Certificate.
	SerialNumber string `json:"serial_number"`
	// The type of hash used for the Client Certificate..
	Signature string `json:"signature"`
	// Subject Key Identifier
	Ski string `json:"ski"`
	// State, provided by the CSR
	State string `json:"state"`
	// Client Certificates may be active or revoked, and the pending_reactivation or
	// pending_revocation represent in-progress asynchronous transitions
	Status TLSCertificatesAndHostnamesClientCertificateStatus `json:"status"`
	// The number of days the Client Certificate will be valid after the issued_on date
	ValidityDays int64                                            `json:"validity_days"`
	JSON         tlsCertificatesAndHostnamesClientCertificateJSON `json:"-"`
}

func (*TLSCertificatesAndHostnamesClientCertificate) UnmarshalJSON 

func (r *TLSCertificatesAndHostnamesClientCertificate) UnmarshalJSON(data []byte) (err error)

type TLSCertificatesAndHostnamesClientCertificateCertificateAuthority 

type TLSCertificatesAndHostnamesClientCertificateCertificateAuthority struct {
	ID   string                                                               `json:"id"`
	Name string                                                               `json:"name"`
	JSON tlsCertificatesAndHostnamesClientCertificateCertificateAuthorityJSON `json:"-"`
}

Certificate Authority used to issue the Client Certificate

func (*TLSCertificatesAndHostnamesClientCertificateCertificateAuthority) UnmarshalJSON 

func (r *TLSCertificatesAndHostnamesClientCertificateCertificateAuthority) UnmarshalJSON(data []byte) (err error)

type TLSCertificatesAndHostnamesClientCertificateStatus 

type TLSCertificatesAndHostnamesClientCertificateStatus string

Client Certificates may be active or revoked, and the pending_reactivation or pending_revocation represent in-progress asynchronous transitions 

const (
	TLSCertificatesAndHostnamesClientCertificateStatusActive              TLSCertificatesAndHostnamesClientCertificateStatus = "active"
	TLSCertificatesAndHostnamesClientCertificateStatusPendingReactivation TLSCertificatesAndHostnamesClientCertificateStatus = "pending_reactivation"
	TLSCertificatesAndHostnamesClientCertificateStatusPendingRevocation   TLSCertificatesAndHostnamesClientCertificateStatus = "pending_revocation"
	TLSCertificatesAndHostnamesClientCertificateStatusRevoked             TLSCertificatesAndHostnamesClientCertificateStatus = "revoked"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.