certificate_authorities

package
v2.0.0 Latest Latest
Warning

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

Go to latest
Published: Apr 12, 2024 License: Apache-2.0 Imports: 11 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 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 CertificateAuthorityService

type CertificateAuthorityService struct {
	Options              []option.RequestOption
	HostnameAssociations *HostnameAssociationService
}

CertificateAuthorityService 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 NewCertificateAuthorityService method instead.

func NewCertificateAuthorityService

func NewCertificateAuthorityService(opts ...option.RequestOption) (r *CertificateAuthorityService)

NewCertificateAuthorityService 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.

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 HostnameAssociation

type HostnameAssociation = string

type HostnameAssociationGetParams

type HostnameAssociationGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The UUID to match against for a certificate that was uploaded to the mTLS
	// Certificate Management endpoint. If no mtls_certificate_id is given, the results
	// will be the hostnames associated to your active Cloudflare Managed CA.
	MTLSCertificateID param.Field[string] `query:"mtls_certificate_id"`
}

func (HostnameAssociationGetParams) URLQuery

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

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

type HostnameAssociationGetResponse

type HostnameAssociationGetResponse struct {
	Hostnames []HostnameAssociation              `json:"hostnames"`
	JSON      hostnameAssociationGetResponseJSON `json:"-"`
}

func (*HostnameAssociationGetResponse) UnmarshalJSON

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

type HostnameAssociationGetResponseEnvelope

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

func (*HostnameAssociationGetResponseEnvelope) UnmarshalJSON

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

type HostnameAssociationGetResponseEnvelopeSuccess

type HostnameAssociationGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	HostnameAssociationGetResponseEnvelopeSuccessTrue HostnameAssociationGetResponseEnvelopeSuccess = true
)

func (HostnameAssociationGetResponseEnvelopeSuccess) IsKnown

type HostnameAssociationParam

type HostnameAssociationParam = string

type HostnameAssociationService

type HostnameAssociationService struct {
	Options []option.RequestOption
}

HostnameAssociationService 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 NewHostnameAssociationService method instead.

func NewHostnameAssociationService

func NewHostnameAssociationService(opts ...option.RequestOption) (r *HostnameAssociationService)

NewHostnameAssociationService 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 (*HostnameAssociationService) Get

List Hostname Associations

func (*HostnameAssociationService) Update

Replace Hostname Associations

type HostnameAssociationUpdateParams

type HostnameAssociationUpdateParams struct {
	// Identifier
	ZoneID                 param.Field[string]         `path:"zone_id,required"`
	TLSHostnameAssociation TLSHostnameAssociationParam `json:"tls_hostname_association,required"`
}

func (HostnameAssociationUpdateParams) MarshalJSON

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

type HostnameAssociationUpdateResponse

type HostnameAssociationUpdateResponse struct {
	Hostnames []HostnameAssociation                 `json:"hostnames"`
	JSON      hostnameAssociationUpdateResponseJSON `json:"-"`
}

func (*HostnameAssociationUpdateResponse) UnmarshalJSON

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

type HostnameAssociationUpdateResponseEnvelope

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

func (*HostnameAssociationUpdateResponseEnvelope) UnmarshalJSON

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

type HostnameAssociationUpdateResponseEnvelopeSuccess

type HostnameAssociationUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	HostnameAssociationUpdateResponseEnvelopeSuccessTrue HostnameAssociationUpdateResponseEnvelopeSuccess = true
)

func (HostnameAssociationUpdateResponseEnvelopeSuccess) IsKnown

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.

type TLSHostnameAssociationParam

type TLSHostnameAssociationParam struct {
	Hostnames param.Field[[]HostnameAssociationParam] `json:"hostnames"`
	// The UUID for a certificate that was uploaded to the mTLS Certificate Management
	// endpoint. If no mtls_certificate_id is given, the hostnames will be associated
	// to your active Cloudflare Managed CA.
	MTLSCertificateID param.Field[string] `json:"mtls_certificate_id"`
}

func (TLSHostnameAssociationParam) MarshalJSON

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

type User

type User = shared.User

This is an alias to an internal type.

type UserParam

type UserParam = shared.UserParam

This is an alias to an internal type.

type UserRole

type UserRole = shared.UserRole

This is an alias to an internal type.

type UserRoleParam

type UserRoleParam = shared.UserRoleParam

This is an alias to an internal type.

type UserRolesPermissions

type UserRolesPermissions = shared.UserRolesPermissions

This is an alias to an internal type.

type UserRolesPermissionsParam

type UserRolesPermissionsParam = shared.UserRolesPermissionsParam

This is an alias to an internal type.

type UserUser

type UserUser = shared.UserUser

This is an alias to an internal type.

type UserUserParam

type UserUserParam = shared.UserUserParam

This is an alias to an internal type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL