origin_ca_certificates

package
v2.1.0 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN added in v2.1.0 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type Member added in v2.1.0 

type Member = shared.Member

This is an alias to an internal type.

type MemberParam added in v2.1.0 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRole added in v2.1.0 

type MemberRole = shared.MemberRole

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissions added in v2.1.0 

type MemberRolesPermissions = shared.MemberRolesPermissions

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberUser added in v2.1.0 

type MemberUser = shared.MemberUser

This is an alias to an internal type.

type MemberUserParam added in v2.1.0 

type MemberUserParam = shared.MemberUserParam

This is an alias to an internal type.

type OriginCACertificate 

type OriginCACertificate struct {
	// The Certificate Signing Request (CSR). Must be newline-encoded.
	Csr string `json:"csr,required"`
	// Array of hostnames or wildcard names (e.g., \*.example.com) bound to the
	// certificate.
	Hostnames []interface{} `json:"hostnames,required"`
	// Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa),
	// or "keyless-certificate" (for Keyless SSL servers).
	RequestType OriginCACertificateRequestType `json:"request_type,required"`
	// The number of days for which the certificate should be valid.
	RequestedValidity OriginCACertificateRequestedValidity `json:"requested_validity,required"`
	// Identifier
	ID string `json:"id"`
	// The Origin CA certificate. Will be newline-encoded.
	Certificate string `json:"certificate"`
	// When the certificate will expire.
	ExpiresOn time.Time               `json:"expires_on" format:"date-time"`
	JSON      originCACertificateJSON `json:"-"`
}

func (*OriginCACertificate) UnmarshalJSON 

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

type OriginCACertificateDeleteParams 

type OriginCACertificateDeleteParams struct {
	Body interface{} `json:"body,required"`
}

func (OriginCACertificateDeleteParams) MarshalJSON 

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

type OriginCACertificateDeleteResponse 

type OriginCACertificateDeleteResponse struct {
	// Identifier
	ID   string                                `json:"id"`
	JSON originCACertificateDeleteResponseJSON `json:"-"`
}

func (*OriginCACertificateDeleteResponse) UnmarshalJSON 

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

type OriginCACertificateDeleteResponseEnvelope 

type OriginCACertificateDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo             `json:"errors,required"`
	Messages []shared.ResponseInfo             `json:"messages,required"`
	Result   OriginCACertificateDeleteResponse `json:"result,required"`
	// Whether the API call was successful
	Success OriginCACertificateDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    originCACertificateDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*OriginCACertificateDeleteResponseEnvelope) UnmarshalJSON 

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

type OriginCACertificateDeleteResponseEnvelopeSuccess 

type OriginCACertificateDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	OriginCACertificateDeleteResponseEnvelopeSuccessTrue OriginCACertificateDeleteResponseEnvelopeSuccess = true
)

func (OriginCACertificateDeleteResponseEnvelopeSuccess) IsKnown 

func (r OriginCACertificateDeleteResponseEnvelopeSuccess) IsKnown() bool

type OriginCACertificateGetResponseEnvelope 

type OriginCACertificateGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo               `json:"errors,required"`
	Messages []shared.ResponseInfo               `json:"messages,required"`
	Result   OriginCACertificateGetResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success OriginCACertificateGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    originCACertificateGetResponseEnvelopeJSON    `json:"-"`
}

func (*OriginCACertificateGetResponseEnvelope) UnmarshalJSON 

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

type OriginCACertificateGetResponseEnvelopeSuccess 

type OriginCACertificateGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	OriginCACertificateGetResponseEnvelopeSuccessTrue OriginCACertificateGetResponseEnvelopeSuccess = true
)

func (OriginCACertificateGetResponseEnvelopeSuccess) IsKnown 

func (r OriginCACertificateGetResponseEnvelopeSuccess) IsKnown() bool

type OriginCACertificateGetResponseUnion 

type OriginCACertificateGetResponseUnion interface {
	ImplementsOriginCACertificatesOriginCACertificateGetResponseUnion()
}

Union satisfied by origin_ca_certificates.OriginCACertificateGetResponseUnknown or shared.UnionString.

type OriginCACertificateListParams 

type OriginCACertificateListParams struct {
	// Identifier
	Identifier param.Field[string] `query:"identifier"`
}

func (OriginCACertificateListParams) URLQuery 

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

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

type OriginCACertificateNewParams 

type OriginCACertificateNewParams struct {
	// The Certificate Signing Request (CSR). Must be newline-encoded.
	Csr param.Field[string] `json:"csr"`
	// Array of hostnames or wildcard names (e.g., \*.example.com) bound to the
	// certificate.
	Hostnames param.Field[[]interface{}] `json:"hostnames"`
	// Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa),
	// or "keyless-certificate" (for Keyless SSL servers).
	RequestType param.Field[OriginCACertificateNewParamsRequestType] `json:"request_type"`
	// The number of days for which the certificate should be valid.
	RequestedValidity param.Field[OriginCACertificateNewParamsRequestedValidity] `json:"requested_validity"`
}

func (OriginCACertificateNewParams) MarshalJSON 

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

type OriginCACertificateNewParamsRequestType 

type OriginCACertificateNewParamsRequestType string

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers). 

const (
	OriginCACertificateNewParamsRequestTypeOriginRsa          OriginCACertificateNewParamsRequestType = "origin-rsa"
	OriginCACertificateNewParamsRequestTypeOriginEcc          OriginCACertificateNewParamsRequestType = "origin-ecc"
	OriginCACertificateNewParamsRequestTypeKeylessCertificate OriginCACertificateNewParamsRequestType = "keyless-certificate"
)

func (OriginCACertificateNewParamsRequestType) IsKnown 

func (r OriginCACertificateNewParamsRequestType) IsKnown() bool

type OriginCACertificateNewParamsRequestedValidity 

type OriginCACertificateNewParamsRequestedValidity float64

The number of days for which the certificate should be valid. 

const (
	OriginCACertificateNewParamsRequestedValidity7    OriginCACertificateNewParamsRequestedValidity = 7
	OriginCACertificateNewParamsRequestedValidity30   OriginCACertificateNewParamsRequestedValidity = 30
	OriginCACertificateNewParamsRequestedValidity90   OriginCACertificateNewParamsRequestedValidity = 90
	OriginCACertificateNewParamsRequestedValidity365  OriginCACertificateNewParamsRequestedValidity = 365
	OriginCACertificateNewParamsRequestedValidity730  OriginCACertificateNewParamsRequestedValidity = 730
	OriginCACertificateNewParamsRequestedValidity1095 OriginCACertificateNewParamsRequestedValidity = 1095
	OriginCACertificateNewParamsRequestedValidity5475 OriginCACertificateNewParamsRequestedValidity = 5475
)

func (OriginCACertificateNewParamsRequestedValidity) IsKnown 

func (r OriginCACertificateNewParamsRequestedValidity) IsKnown() bool

type OriginCACertificateNewResponseEnvelope 

type OriginCACertificateNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo               `json:"errors,required"`
	Messages []shared.ResponseInfo               `json:"messages,required"`
	Result   OriginCACertificateNewResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success OriginCACertificateNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    originCACertificateNewResponseEnvelopeJSON    `json:"-"`
}

func (*OriginCACertificateNewResponseEnvelope) UnmarshalJSON 

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

type OriginCACertificateNewResponseEnvelopeSuccess 

type OriginCACertificateNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	OriginCACertificateNewResponseEnvelopeSuccessTrue OriginCACertificateNewResponseEnvelopeSuccess = true
)

func (OriginCACertificateNewResponseEnvelopeSuccess) IsKnown 

func (r OriginCACertificateNewResponseEnvelopeSuccess) IsKnown() bool

type OriginCACertificateNewResponseUnion 

type OriginCACertificateNewResponseUnion interface {
	ImplementsOriginCACertificatesOriginCACertificateNewResponseUnion()
}

Union satisfied by origin_ca_certificates.OriginCACertificateNewResponseUnknown or shared.UnionString.

type OriginCACertificateRequestType 

type OriginCACertificateRequestType string

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers). 

const (
	OriginCACertificateRequestTypeOriginRsa          OriginCACertificateRequestType = "origin-rsa"
	OriginCACertificateRequestTypeOriginEcc          OriginCACertificateRequestType = "origin-ecc"
	OriginCACertificateRequestTypeKeylessCertificate OriginCACertificateRequestType = "keyless-certificate"
)

func (OriginCACertificateRequestType) IsKnown 

func (r OriginCACertificateRequestType) IsKnown() bool

type OriginCACertificateRequestedValidity 

type OriginCACertificateRequestedValidity float64

The number of days for which the certificate should be valid. 

const (
	OriginCACertificateRequestedValidity7    OriginCACertificateRequestedValidity = 7
	OriginCACertificateRequestedValidity30   OriginCACertificateRequestedValidity = 30
	OriginCACertificateRequestedValidity90   OriginCACertificateRequestedValidity = 90
	OriginCACertificateRequestedValidity365  OriginCACertificateRequestedValidity = 365
	OriginCACertificateRequestedValidity730  OriginCACertificateRequestedValidity = 730
	OriginCACertificateRequestedValidity1095 OriginCACertificateRequestedValidity = 1095
	OriginCACertificateRequestedValidity5475 OriginCACertificateRequestedValidity = 5475
)

func (OriginCACertificateRequestedValidity) IsKnown 

func (r OriginCACertificateRequestedValidity) IsKnown() bool

type OriginCACertificateService 

type OriginCACertificateService struct {
	Options []option.RequestOption
}

OriginCACertificateService 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 NewOriginCACertificateService method instead.

func NewOriginCACertificateService 

func NewOriginCACertificateService(opts ...option.RequestOption) (r *OriginCACertificateService)

NewOriginCACertificateService 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 (*OriginCACertificateService) Delete 

func (r *OriginCACertificateService) Delete(ctx context.Context, certificateID string, body OriginCACertificateDeleteParams, opts ...option.RequestOption) (res *OriginCACertificateDeleteResponse, err error)

Revoke an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).

func (*OriginCACertificateService) Get 

func (r *OriginCACertificateService) Get(ctx context.Context, certificateID string, opts ...option.RequestOption) (res *OriginCACertificateGetResponseUnion, err error)

Get an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).

func (*OriginCACertificateService) List 

func (r *OriginCACertificateService) List(ctx context.Context, query OriginCACertificateListParams, opts ...option.RequestOption) (res *pagination.SinglePage[OriginCACertificate], err error)

List all existing Origin CA certificates for a given zone. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).

func (*OriginCACertificateService) ListAutoPaging 

func (r *OriginCACertificateService) ListAutoPaging(ctx context.Context, query OriginCACertificateListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[OriginCACertificate]

List all existing Origin CA certificates for a given zone. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).

func (*OriginCACertificateService) New 

func (r *OriginCACertificateService) New(ctx context.Context, body OriginCACertificateNewParams, opts ...option.RequestOption) (res *OriginCACertificateNewResponseUnion, err error)

Create an Origin CA certificate. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

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.