custom_csrs

package
v7.5.0 Latest Latest
Warning

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

 Go to latest Published: Jun 10, 2026 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 CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

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 CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

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 CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate.

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

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

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 CloudflareTunnelConfigSrc 

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

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 CustomCsrDeleteParams 

type CustomCsrDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type CustomCsrDeleteResponse 

type CustomCsrDeleteResponse struct {
	// Custom CSR identifier tag.
	ID   string                      `json:"id"`
	JSON customCsrDeleteResponseJSON `json:"-"`
}

func (*CustomCsrDeleteResponse) UnmarshalJSON 

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

type CustomCsrDeleteResponseEnvelope 

type CustomCsrDeleteResponseEnvelope struct {
	Errors   []CustomCsrDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []CustomCsrDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success CustomCsrDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  CustomCsrDeleteResponse                `json:"result"`
	JSON    customCsrDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*CustomCsrDeleteResponseEnvelope) UnmarshalJSON 

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

type CustomCsrDeleteResponseEnvelopeErrors 

type CustomCsrDeleteResponseEnvelopeErrors struct {
	Code             int64                                       `json:"code" api:"required"`
	Message          string                                      `json:"message" api:"required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           CustomCsrDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             customCsrDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*CustomCsrDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type CustomCsrDeleteResponseEnvelopeErrorsSource 

type CustomCsrDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    customCsrDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*CustomCsrDeleteResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type CustomCsrDeleteResponseEnvelopeMessages 

type CustomCsrDeleteResponseEnvelopeMessages struct {
	Code             int64                                         `json:"code" api:"required"`
	Message          string                                        `json:"message" api:"required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           CustomCsrDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             customCsrDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*CustomCsrDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type CustomCsrDeleteResponseEnvelopeMessagesSource 

type CustomCsrDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    customCsrDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*CustomCsrDeleteResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type CustomCsrDeleteResponseEnvelopeSuccess 

type CustomCsrDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	CustomCsrDeleteResponseEnvelopeSuccessTrue CustomCsrDeleteResponseEnvelopeSuccess = true
)

func (CustomCsrDeleteResponseEnvelopeSuccess) IsKnown 

func (r CustomCsrDeleteResponseEnvelopeSuccess) IsKnown() bool

type CustomCsrGetParams 

type CustomCsrGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type CustomCsrGetResponse 

type CustomCsrGetResponse struct {
	// Custom CSR identifier tag.
	ID string `json:"id" api:"required"`
	// When the CSR was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// The key algorithm used to generate the CSR.
	KeyType CustomCsrGetResponseKeyType `json:"key_type" api:"required"`
	// Account identifier associated with this CSR.
	AccountTag string `json:"account_tag"`
	// The common name (domain) for the CSR.
	CommonName string `json:"common_name"`
	// Two-letter ISO 3166-1 alpha-2 country code.
	Country string `json:"country"`
	// The PEM-encoded Certificate Signing Request.
	Csr string `json:"csr"`
	// Optional description for the CSR.
	Description string `json:"description"`
	// City or locality name.
	Locality string `json:"locality"`
	// Human-readable name for the CSR.
	Name string `json:"name"`
	// Organization name.
	Organization string `json:"organization"`
	// Organizational unit name.
	OrganizationalUnit string `json:"organizational_unit"`
	// Subject Alternative Names included in the CSR.
	Sans []string `json:"sans"`
	// State or province name.
	State string                   `json:"state"`
	JSON  customCsrGetResponseJSON `json:"-"`
}

A custom Certificate Signing Request (CSR).

func (*CustomCsrGetResponse) UnmarshalJSON 

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

type CustomCsrGetResponseEnvelope 

type CustomCsrGetResponseEnvelope struct {
	Errors   []CustomCsrGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []CustomCsrGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success CustomCsrGetResponseEnvelopeSuccess `json:"success" api:"required"`
	// A custom Certificate Signing Request (CSR).
	Result CustomCsrGetResponse             `json:"result"`
	JSON   customCsrGetResponseEnvelopeJSON `json:"-"`
}

func (*CustomCsrGetResponseEnvelope) UnmarshalJSON 

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

type CustomCsrGetResponseEnvelopeErrors 

type CustomCsrGetResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           CustomCsrGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             customCsrGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*CustomCsrGetResponseEnvelopeErrors) UnmarshalJSON 

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

type CustomCsrGetResponseEnvelopeErrorsSource 

type CustomCsrGetResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    customCsrGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*CustomCsrGetResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type CustomCsrGetResponseEnvelopeMessages 

type CustomCsrGetResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           CustomCsrGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             customCsrGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*CustomCsrGetResponseEnvelopeMessages) UnmarshalJSON 

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

type CustomCsrGetResponseEnvelopeMessagesSource 

type CustomCsrGetResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    customCsrGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*CustomCsrGetResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type CustomCsrGetResponseEnvelopeSuccess 

type CustomCsrGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	CustomCsrGetResponseEnvelopeSuccessTrue CustomCsrGetResponseEnvelopeSuccess = true
)

func (CustomCsrGetResponseEnvelopeSuccess) IsKnown 

func (r CustomCsrGetResponseEnvelopeSuccess) IsKnown() bool

type CustomCsrGetResponseKeyType 

type CustomCsrGetResponseKeyType string

The key algorithm used to generate the CSR. 

const (
	CustomCsrGetResponseKeyTypeRsa2048 CustomCsrGetResponseKeyType = "rsa2048"
	CustomCsrGetResponseKeyTypeP256v1  CustomCsrGetResponseKeyType = "p256v1"
)

func (CustomCsrGetResponseKeyType) IsKnown 

func (r CustomCsrGetResponseKeyType) IsKnown() bool

type CustomCsrListParams 

type CustomCsrListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Number of custom CSRs per page.
	PerPage param.Field[float64] `query:"per_page"`
}

func (CustomCsrListParams) URLQuery 

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

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

type CustomCsrListResponse 

type CustomCsrListResponse struct {
	// Custom CSR identifier tag.
	ID string `json:"id" api:"required"`
	// When the CSR was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// The key algorithm used to generate the CSR.
	KeyType CustomCsrListResponseKeyType `json:"key_type" api:"required"`
	// Account identifier associated with this CSR.
	AccountTag string `json:"account_tag"`
	// The common name (domain) for the CSR.
	CommonName string `json:"common_name"`
	// Two-letter ISO 3166-1 alpha-2 country code.
	Country string `json:"country"`
	// The PEM-encoded Certificate Signing Request.
	Csr string `json:"csr"`
	// Optional description for the CSR.
	Description string `json:"description"`
	// City or locality name.
	Locality string `json:"locality"`
	// Human-readable name for the CSR.
	Name string `json:"name"`
	// Organization name.
	Organization string `json:"organization"`
	// Organizational unit name.
	OrganizationalUnit string `json:"organizational_unit"`
	// Subject Alternative Names included in the CSR.
	Sans []string `json:"sans"`
	// State or province name.
	State string                    `json:"state"`
	JSON  customCsrListResponseJSON `json:"-"`
}

A custom Certificate Signing Request (CSR).

func (*CustomCsrListResponse) UnmarshalJSON 

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

type CustomCsrListResponseKeyType 

type CustomCsrListResponseKeyType string

The key algorithm used to generate the CSR. 

const (
	CustomCsrListResponseKeyTypeRsa2048 CustomCsrListResponseKeyType = "rsa2048"
	CustomCsrListResponseKeyTypeP256v1  CustomCsrListResponseKeyType = "p256v1"
)

func (CustomCsrListResponseKeyType) IsKnown 

func (r CustomCsrListResponseKeyType) IsKnown() bool

type CustomCsrNewParams 

type CustomCsrNewParams struct {
	// The common name (domain) for the CSR. Must be at most 64 characters.
	CommonName param.Field[string] `json:"common_name" api:"required"`
	// Two-letter ISO 3166-1 alpha-2 country code.
	Country param.Field[string] `json:"country" api:"required"`
	// City or locality name.
	Locality param.Field[string] `json:"locality" api:"required"`
	// Organization name.
	Organization param.Field[string] `json:"organization" api:"required"`
	// Subject Alternative Names for the CSR. At least one SAN is required.
	Sans param.Field[[]string] `json:"sans" api:"required"`
	// State or province name.
	State param.Field[string] `json:"state" api:"required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// Optional description for the CSR.
	Description param.Field[string] `json:"description"`
	// Key algorithm to use for the CSR. Defaults to rsa2048 if not specified.
	KeyType param.Field[CustomCsrNewParamsKeyType] `json:"key_type"`
	// Human-readable name for the CSR.
	Name param.Field[string] `json:"name"`
	// Organizational unit name.
	OrganizationalUnit param.Field[string] `json:"organizational_unit"`
}

func (CustomCsrNewParams) MarshalJSON 

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

type CustomCsrNewParamsKeyType 

type CustomCsrNewParamsKeyType string

Key algorithm to use for the CSR. Defaults to rsa2048 if not specified. 

const (
	CustomCsrNewParamsKeyTypeRsa2048 CustomCsrNewParamsKeyType = "rsa2048"
	CustomCsrNewParamsKeyTypeP256v1  CustomCsrNewParamsKeyType = "p256v1"
)

func (CustomCsrNewParamsKeyType) IsKnown 

func (r CustomCsrNewParamsKeyType) IsKnown() bool

type CustomCsrNewResponse 

type CustomCsrNewResponse struct {
	// Custom CSR identifier tag.
	ID string `json:"id" api:"required"`
	// When the CSR was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// The key algorithm used to generate the CSR.
	KeyType CustomCsrNewResponseKeyType `json:"key_type" api:"required"`
	// Account identifier associated with this CSR.
	AccountTag string `json:"account_tag"`
	// The common name (domain) for the CSR.
	CommonName string `json:"common_name"`
	// Two-letter ISO 3166-1 alpha-2 country code.
	Country string `json:"country"`
	// The PEM-encoded Certificate Signing Request.
	Csr string `json:"csr"`
	// Optional description for the CSR.
	Description string `json:"description"`
	// City or locality name.
	Locality string `json:"locality"`
	// Human-readable name for the CSR.
	Name string `json:"name"`
	// Organization name.
	Organization string `json:"organization"`
	// Organizational unit name.
	OrganizationalUnit string `json:"organizational_unit"`
	// Subject Alternative Names included in the CSR.
	Sans []string `json:"sans"`
	// State or province name.
	State string                   `json:"state"`
	JSON  customCsrNewResponseJSON `json:"-"`
}

A custom Certificate Signing Request (CSR).

func (*CustomCsrNewResponse) UnmarshalJSON 

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

type CustomCsrNewResponseEnvelope 

type CustomCsrNewResponseEnvelope struct {
	Errors   []CustomCsrNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []CustomCsrNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success CustomCsrNewResponseEnvelopeSuccess `json:"success" api:"required"`
	// A custom Certificate Signing Request (CSR).
	Result CustomCsrNewResponse             `json:"result"`
	JSON   customCsrNewResponseEnvelopeJSON `json:"-"`
}

func (*CustomCsrNewResponseEnvelope) UnmarshalJSON 

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

type CustomCsrNewResponseEnvelopeErrors 

type CustomCsrNewResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           CustomCsrNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             customCsrNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*CustomCsrNewResponseEnvelopeErrors) UnmarshalJSON 

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

type CustomCsrNewResponseEnvelopeErrorsSource 

type CustomCsrNewResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    customCsrNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*CustomCsrNewResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type CustomCsrNewResponseEnvelopeMessages 

type CustomCsrNewResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           CustomCsrNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             customCsrNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*CustomCsrNewResponseEnvelopeMessages) UnmarshalJSON 

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

type CustomCsrNewResponseEnvelopeMessagesSource 

type CustomCsrNewResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    customCsrNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*CustomCsrNewResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type CustomCsrNewResponseEnvelopeSuccess 

type CustomCsrNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	CustomCsrNewResponseEnvelopeSuccessTrue CustomCsrNewResponseEnvelopeSuccess = true
)

func (CustomCsrNewResponseEnvelopeSuccess) IsKnown 

func (r CustomCsrNewResponseEnvelopeSuccess) IsKnown() bool

type CustomCsrNewResponseKeyType 

type CustomCsrNewResponseKeyType string

The key algorithm used to generate the CSR. 

const (
	CustomCsrNewResponseKeyTypeRsa2048 CustomCsrNewResponseKeyType = "rsa2048"
	CustomCsrNewResponseKeyTypeP256v1  CustomCsrNewResponseKeyType = "p256v1"
)

func (CustomCsrNewResponseKeyType) IsKnown 

func (r CustomCsrNewResponseKeyType) IsKnown() bool

type CustomCsrService 

type CustomCsrService struct {
	Options []option.RequestOption
}

CustomCsrService 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 NewCustomCsrService method instead.

func NewCustomCsrService 

func NewCustomCsrService(opts ...option.RequestOption) (r *CustomCsrService)

NewCustomCsrService 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 (*CustomCsrService) Delete 

func (r *CustomCsrService) Delete(ctx context.Context, customCsrID string, body CustomCsrDeleteParams, opts ...option.RequestOption) (res *CustomCsrDeleteResponse, err error)

Delete a custom Certificate Signing Request (CSR) and its associated private key.

func (*CustomCsrService) Get 

func (r *CustomCsrService) Get(ctx context.Context, customCsrID string, query CustomCsrGetParams, opts ...option.RequestOption) (res *CustomCsrGetResponse, err error)

Retrieve details for a specific custom Certificate Signing Request (CSR).

func (*CustomCsrService) List 

func (r *CustomCsrService) List(ctx context.Context, params CustomCsrListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[CustomCsrListResponse], err error)

List all custom Certificate Signing Requests (CSRs) for an account or zone.

func (*CustomCsrService) ListAutoPaging 

func (r *CustomCsrService) ListAutoPaging(ctx context.Context, params CustomCsrListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[CustomCsrListResponse]

List all custom Certificate Signing Requests (CSRs) for an account or zone.

func (*CustomCsrService) New 

func (r *CustomCsrService) New(ctx context.Context, params CustomCsrNewParams, opts ...option.RequestOption) (res *CustomCsrNewResponse, err error)

Generate a new custom Certificate Signing Request (CSR) for an account or zone. Cloudflare generates and securely stores the private key associated with the CSR.

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource 

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser 

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

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 RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource 

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested 

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam 

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString 

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam 

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion 

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam 

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue 

type TokenValue = shared.TokenValue

The token value.

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.