token_validation

package
v6.6.0 Latest Latest
Warning

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

Go to latest
Published: Jan 16, 2026 License: Apache-2.0 Imports: 18 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 ConfigurationCredentialService

type ConfigurationCredentialService struct {
	Options []option.RequestOption
}

ConfigurationCredentialService 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 NewConfigurationCredentialService method instead.

func NewConfigurationCredentialService

func NewConfigurationCredentialService(opts ...option.RequestOption) (r *ConfigurationCredentialService)

NewConfigurationCredentialService 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 (*ConfigurationCredentialService) Update

Update Token Configuration credentials

type ConfigurationCredentialUpdateParams

type ConfigurationCredentialUpdateParams struct {
	// Identifier.
	ZoneID param.Field[string]                                        `path:"zone_id,required"`
	Keys   param.Field[[]ConfigurationCredentialUpdateParamsKeyUnion] `json:"keys,required"`
}

func (ConfigurationCredentialUpdateParams) MarshalJSON

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

type ConfigurationCredentialUpdateParamsKey

type ConfigurationCredentialUpdateParamsKey struct {
	// Algorithm
	Alg param.Field[ConfigurationCredentialUpdateParamsKeysAlg] `json:"alg,required"`
	// Key ID
	Kid param.Field[string] `json:"kid,required"`
	// Key Type
	Kty param.Field[ConfigurationCredentialUpdateParamsKeysKty] `json:"kty,required"`
	// Curve
	Crv param.Field[ConfigurationCredentialUpdateParamsKeysCrv] `json:"crv"`
	// RSA exponent
	E param.Field[string] `json:"e"`
	// RSA modulus
	N param.Field[string] `json:"n"`
	// X EC coordinate
	X param.Field[string] `json:"x"`
	// Y EC coordinate
	Y param.Field[string] `json:"y"`
}

JSON representation of a JWKS key.

func (ConfigurationCredentialUpdateParamsKey) MarshalJSON

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

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256 struct {
	// Algorithm
	Alg param.Field[ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Alg] `json:"alg,required"`
	// Curve
	Crv param.Field[ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Crv] `json:"crv,required"`
	// Key ID
	Kid param.Field[string] `json:"kid,required"`
	// Key Type
	Kty param.Field[ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Kty] `json:"kty,required"`
	// X EC coordinate
	X param.Field[string] `json:"x,required"`
	// Y EC coordinate
	Y param.Field[string] `json:"y,required"`
}

JSON representation of an ES256 key

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256) MarshalJSON

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Alg

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Alg string

Algorithm

const (
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256AlgEs256 ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Alg = "ES256"
)

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Alg) IsKnown

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Crv

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Crv string

Curve

const (
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256CrvP256 ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Crv = "P-256"
)

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Crv) IsKnown

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Kty

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Kty string

Key Type

const (
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256KtyEc ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Kty = "EC"
)

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs256Kty) IsKnown

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384 struct {
	// Algorithm
	Alg param.Field[ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Alg] `json:"alg,required"`
	// Curve
	Crv param.Field[ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Crv] `json:"crv,required"`
	// Key ID
	Kid param.Field[string] `json:"kid,required"`
	// Key Type
	Kty param.Field[ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Kty] `json:"kty,required"`
	// X EC coordinate
	X param.Field[string] `json:"x,required"`
	// Y EC coordinate
	Y param.Field[string] `json:"y,required"`
}

JSON representation of an ES384 key

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384) MarshalJSON

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Alg

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Alg string

Algorithm

const (
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384AlgEs384 ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Alg = "ES384"
)

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Alg) IsKnown

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Crv

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Crv string

Curve

const (
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384CrvP384 ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Crv = "P-384"
)

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Crv) IsKnown

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Kty

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Kty string

Key Type

const (
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384KtyEc ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Kty = "EC"
)

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyEcEs384Kty) IsKnown

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSA

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSA struct {
	// Algorithm
	Alg param.Field[ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlg] `json:"alg,required"`
	// RSA exponent
	E param.Field[string] `json:"e,required"`
	// Key ID
	Kid param.Field[string] `json:"kid,required"`
	// Key Type
	Kty param.Field[ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAKty] `json:"kty,required"`
	// RSA modulus
	N param.Field[string] `json:"n,required"`
}

JSON representation of an RSA key.

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSA) MarshalJSON

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlg

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlg string

Algorithm

const (
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlgRs256 ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS256"
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlgRs384 ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS384"
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlgRs512 ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS512"
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlgPs256 ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS256"
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlgPs384 ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS384"
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlgPs512 ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS512"
)

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAAlg) IsKnown

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAKty

type ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAKty string

Key Type

const (
	ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAKtyRSA ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAKty = "RSA"
)

func (ConfigurationCredentialUpdateParamsKeysAPIShieldCredentialsJWTKeyRSAKty) IsKnown

type ConfigurationCredentialUpdateParamsKeysAlg

type ConfigurationCredentialUpdateParamsKeysAlg string

Algorithm

const (
	ConfigurationCredentialUpdateParamsKeysAlgRs256 ConfigurationCredentialUpdateParamsKeysAlg = "RS256"
	ConfigurationCredentialUpdateParamsKeysAlgRs384 ConfigurationCredentialUpdateParamsKeysAlg = "RS384"
	ConfigurationCredentialUpdateParamsKeysAlgRs512 ConfigurationCredentialUpdateParamsKeysAlg = "RS512"
	ConfigurationCredentialUpdateParamsKeysAlgPs256 ConfigurationCredentialUpdateParamsKeysAlg = "PS256"
	ConfigurationCredentialUpdateParamsKeysAlgPs384 ConfigurationCredentialUpdateParamsKeysAlg = "PS384"
	ConfigurationCredentialUpdateParamsKeysAlgPs512 ConfigurationCredentialUpdateParamsKeysAlg = "PS512"
	ConfigurationCredentialUpdateParamsKeysAlgEs256 ConfigurationCredentialUpdateParamsKeysAlg = "ES256"
	ConfigurationCredentialUpdateParamsKeysAlgEs384 ConfigurationCredentialUpdateParamsKeysAlg = "ES384"
)

func (ConfigurationCredentialUpdateParamsKeysAlg) IsKnown

type ConfigurationCredentialUpdateParamsKeysCrv

type ConfigurationCredentialUpdateParamsKeysCrv string

Curve

const (
	ConfigurationCredentialUpdateParamsKeysCrvP256 ConfigurationCredentialUpdateParamsKeysCrv = "P-256"
	ConfigurationCredentialUpdateParamsKeysCrvP384 ConfigurationCredentialUpdateParamsKeysCrv = "P-384"
)

func (ConfigurationCredentialUpdateParamsKeysCrv) IsKnown

type ConfigurationCredentialUpdateParamsKeysKty

type ConfigurationCredentialUpdateParamsKeysKty string

Key Type

const (
	ConfigurationCredentialUpdateParamsKeysKtyRSA ConfigurationCredentialUpdateParamsKeysKty = "RSA"
	ConfigurationCredentialUpdateParamsKeysKtyEc  ConfigurationCredentialUpdateParamsKeysKty = "EC"
)

func (ConfigurationCredentialUpdateParamsKeysKty) IsKnown

type ConfigurationCredentialUpdateResponse

type ConfigurationCredentialUpdateResponse struct {
	Errors   api_gateway.Message                        `json:"errors,required"`
	Keys     []ConfigurationCredentialUpdateResponseKey `json:"keys,required"`
	Messages api_gateway.Message                        `json:"messages,required"`
	// Whether the API call was successful.
	Success ConfigurationCredentialUpdateResponseSuccess `json:"success,required"`
	JSON    configurationCredentialUpdateResponseJSON    `json:"-"`
}

func (*ConfigurationCredentialUpdateResponse) UnmarshalJSON

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

type ConfigurationCredentialUpdateResponseKey

type ConfigurationCredentialUpdateResponseKey struct {
	// Algorithm
	Alg ConfigurationCredentialUpdateResponseKeysAlg `json:"alg,required"`
	// Key ID
	Kid string `json:"kid,required"`
	// Key Type
	Kty ConfigurationCredentialUpdateResponseKeysKty `json:"kty,required"`
	// Curve
	Crv ConfigurationCredentialUpdateResponseKeysCrv `json:"crv"`
	// RSA exponent
	E string `json:"e"`
	// RSA modulus
	N string `json:"n"`
	// X EC coordinate
	X string `json:"x"`
	// Y EC coordinate
	Y    string                                       `json:"y"`
	JSON configurationCredentialUpdateResponseKeyJSON `json:"-"`
	// contains filtered or unexported fields
}

JSON representation of a JWKS key.

func (*ConfigurationCredentialUpdateResponseKey) UnmarshalJSON

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

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256 struct {
	// Algorithm
	Alg ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Alg `json:"alg,required"`
	// Curve
	Crv ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Crv `json:"crv,required"`
	// Key ID
	Kid string `json:"kid,required"`
	// Key Type
	Kty ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Kty `json:"kty,required"`
	// X EC coordinate
	X string `json:"x,required"`
	// Y EC coordinate
	Y    string                                                                         `json:"y,required"`
	JSON configurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256JSON `json:"-"`
}

JSON representation of an ES256 key

func (*ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256) UnmarshalJSON

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Alg

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Alg string

Algorithm

const (
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256AlgEs256 ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Alg = "ES256"
)

func (ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Alg) IsKnown

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Crv

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Crv string

Curve

const (
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256CrvP256 ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Crv = "P-256"
)

func (ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Crv) IsKnown

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Kty

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Kty string

Key Type

const (
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256KtyEc ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Kty = "EC"
)

func (ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256Kty) IsKnown

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384 struct {
	// Algorithm
	Alg ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Alg `json:"alg,required"`
	// Curve
	Crv ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Crv `json:"crv,required"`
	// Key ID
	Kid string `json:"kid,required"`
	// Key Type
	Kty ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Kty `json:"kty,required"`
	// X EC coordinate
	X string `json:"x,required"`
	// Y EC coordinate
	Y    string                                                                         `json:"y,required"`
	JSON configurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384JSON `json:"-"`
}

JSON representation of an ES384 key

func (*ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384) UnmarshalJSON

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Alg

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Alg string

Algorithm

const (
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384AlgEs384 ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Alg = "ES384"
)

func (ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Alg) IsKnown

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Crv

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Crv string

Curve

const (
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384CrvP384 ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Crv = "P-384"
)

func (ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Crv) IsKnown

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Kty

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Kty string

Key Type

const (
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384KtyEc ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Kty = "EC"
)

func (ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384Kty) IsKnown

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSA

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSA struct {
	// Algorithm
	Alg ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlg `json:"alg,required"`
	// RSA exponent
	E string `json:"e,required"`
	// Key ID
	Kid string `json:"kid,required"`
	// Key Type
	Kty ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAKty `json:"kty,required"`
	// RSA modulus
	N    string                                                                     `json:"n,required"`
	JSON configurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAJSON `json:"-"`
}

JSON representation of an RSA key.

func (*ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSA) UnmarshalJSON

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlg

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlg string

Algorithm

const (
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlgRs256 ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS256"
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlgRs384 ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS384"
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlgRs512 ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS512"
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlgPs256 ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS256"
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlgPs384 ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS384"
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlgPs512 ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS512"
)

func (ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAAlg) IsKnown

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAKty

type ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAKty string

Key Type

const (
	ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAKtyRSA ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAKty = "RSA"
)

func (ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSAKty) IsKnown

type ConfigurationCredentialUpdateResponseKeysAlg

type ConfigurationCredentialUpdateResponseKeysAlg string

Algorithm

const (
	ConfigurationCredentialUpdateResponseKeysAlgRs256 ConfigurationCredentialUpdateResponseKeysAlg = "RS256"
	ConfigurationCredentialUpdateResponseKeysAlgRs384 ConfigurationCredentialUpdateResponseKeysAlg = "RS384"
	ConfigurationCredentialUpdateResponseKeysAlgRs512 ConfigurationCredentialUpdateResponseKeysAlg = "RS512"
	ConfigurationCredentialUpdateResponseKeysAlgPs256 ConfigurationCredentialUpdateResponseKeysAlg = "PS256"
	ConfigurationCredentialUpdateResponseKeysAlgPs384 ConfigurationCredentialUpdateResponseKeysAlg = "PS384"
	ConfigurationCredentialUpdateResponseKeysAlgPs512 ConfigurationCredentialUpdateResponseKeysAlg = "PS512"
	ConfigurationCredentialUpdateResponseKeysAlgEs256 ConfigurationCredentialUpdateResponseKeysAlg = "ES256"
	ConfigurationCredentialUpdateResponseKeysAlgEs384 ConfigurationCredentialUpdateResponseKeysAlg = "ES384"
)

func (ConfigurationCredentialUpdateResponseKeysAlg) IsKnown

type ConfigurationCredentialUpdateResponseKeysCrv

type ConfigurationCredentialUpdateResponseKeysCrv string

Curve

const (
	ConfigurationCredentialUpdateResponseKeysCrvP256 ConfigurationCredentialUpdateResponseKeysCrv = "P-256"
	ConfigurationCredentialUpdateResponseKeysCrvP384 ConfigurationCredentialUpdateResponseKeysCrv = "P-384"
)

func (ConfigurationCredentialUpdateResponseKeysCrv) IsKnown

type ConfigurationCredentialUpdateResponseKeysKty

type ConfigurationCredentialUpdateResponseKeysKty string

Key Type

const (
	ConfigurationCredentialUpdateResponseKeysKtyRSA ConfigurationCredentialUpdateResponseKeysKty = "RSA"
	ConfigurationCredentialUpdateResponseKeysKtyEc  ConfigurationCredentialUpdateResponseKeysKty = "EC"
)

func (ConfigurationCredentialUpdateResponseKeysKty) IsKnown

type ConfigurationCredentialUpdateResponseKeysUnion

type ConfigurationCredentialUpdateResponseKeysUnion interface {
	// contains filtered or unexported methods
}

JSON representation of a JWKS key.

Union satisfied by ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyRSA, ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs256 or ConfigurationCredentialUpdateResponseKeysAPIShieldCredentialsJWTKeyEcEs384.

type ConfigurationCredentialUpdateResponseSuccess

type ConfigurationCredentialUpdateResponseSuccess bool

Whether the API call was successful.

const (
	ConfigurationCredentialUpdateResponseSuccessTrue ConfigurationCredentialUpdateResponseSuccess = true
)

func (ConfigurationCredentialUpdateResponseSuccess) IsKnown

type ConfigurationDeleteParams

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

type ConfigurationDeleteResponse

type ConfigurationDeleteResponse struct {
	// UUID.
	ID   string                          `json:"id"`
	JSON configurationDeleteResponseJSON `json:"-"`
}

func (*ConfigurationDeleteResponse) UnmarshalJSON

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

type ConfigurationDeleteResponseEnvelope

type ConfigurationDeleteResponseEnvelope struct {
	Errors   api_gateway.Message         `json:"errors,required"`
	Messages api_gateway.Message         `json:"messages,required"`
	Result   ConfigurationDeleteResponse `json:"result,required"`
	// Whether the API call was successful.
	Success ConfigurationDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    configurationDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ConfigurationDeleteResponseEnvelope) UnmarshalJSON

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

type ConfigurationDeleteResponseEnvelopeSuccess

type ConfigurationDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ConfigurationDeleteResponseEnvelopeSuccessTrue ConfigurationDeleteResponseEnvelopeSuccess = true
)

func (ConfigurationDeleteResponseEnvelopeSuccess) IsKnown

type ConfigurationEditParams

type ConfigurationEditParams struct {
	// Identifier.
	ZoneID       param.Field[string]   `path:"zone_id,required"`
	Description  param.Field[string]   `json:"description"`
	Title        param.Field[string]   `json:"title"`
	TokenSources param.Field[[]string] `json:"token_sources"`
}

func (ConfigurationEditParams) MarshalJSON

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

type ConfigurationEditResponse

type ConfigurationEditResponse struct {
	Description  string                        `json:"description"`
	Title        string                        `json:"title"`
	TokenSources []string                      `json:"token_sources"`
	JSON         configurationEditResponseJSON `json:"-"`
}

func (*ConfigurationEditResponse) UnmarshalJSON

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

type ConfigurationEditResponseEnvelope

type ConfigurationEditResponseEnvelope struct {
	Errors   api_gateway.Message       `json:"errors,required"`
	Messages api_gateway.Message       `json:"messages,required"`
	Result   ConfigurationEditResponse `json:"result,required"`
	// Whether the API call was successful.
	Success ConfigurationEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    configurationEditResponseEnvelopeJSON    `json:"-"`
}

func (*ConfigurationEditResponseEnvelope) UnmarshalJSON

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

type ConfigurationEditResponseEnvelopeSuccess

type ConfigurationEditResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ConfigurationEditResponseEnvelopeSuccessTrue ConfigurationEditResponseEnvelopeSuccess = true
)

func (ConfigurationEditResponseEnvelopeSuccess) IsKnown

type ConfigurationGetParams

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

type ConfigurationGetResponseEnvelope

type ConfigurationGetResponseEnvelope struct {
	Errors   api_gateway.Message `json:"errors,required"`
	Messages api_gateway.Message `json:"messages,required"`
	Result   TokenConfig         `json:"result,required"`
	// Whether the API call was successful.
	Success ConfigurationGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    configurationGetResponseEnvelopeJSON    `json:"-"`
}

func (*ConfigurationGetResponseEnvelope) UnmarshalJSON

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

type ConfigurationGetResponseEnvelopeSuccess

type ConfigurationGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ConfigurationGetResponseEnvelopeSuccessTrue ConfigurationGetResponseEnvelopeSuccess = true
)

func (ConfigurationGetResponseEnvelopeSuccess) IsKnown

type ConfigurationListParams

type ConfigurationListParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Page number of paginated results.
	Page param.Field[int64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
}

func (ConfigurationListParams) URLQuery

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

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

type ConfigurationNewParams

type ConfigurationNewParams struct {
	// Identifier.
	ZoneID       param.Field[string]                            `path:"zone_id,required"`
	Credentials  param.Field[ConfigurationNewParamsCredentials] `json:"credentials,required"`
	Description  param.Field[string]                            `json:"description,required"`
	Title        param.Field[string]                            `json:"title,required"`
	TokenSources param.Field[[]string]                          `json:"token_sources,required"`
	TokenType    param.Field[ConfigurationNewParamsTokenType]   `json:"token_type,required"`
}

func (ConfigurationNewParams) MarshalJSON

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

type ConfigurationNewParamsCredentials

type ConfigurationNewParamsCredentials struct {
	Keys param.Field[[]ConfigurationNewParamsCredentialsKeyUnion] `json:"keys,required"`
}

func (ConfigurationNewParamsCredentials) MarshalJSON

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

type ConfigurationNewParamsCredentialsKey

type ConfigurationNewParamsCredentialsKey struct {
	// Algorithm
	Alg param.Field[ConfigurationNewParamsCredentialsKeysAlg] `json:"alg,required"`
	// Key ID
	Kid param.Field[string] `json:"kid,required"`
	// Key Type
	Kty param.Field[ConfigurationNewParamsCredentialsKeysKty] `json:"kty,required"`
	// Curve
	Crv param.Field[ConfigurationNewParamsCredentialsKeysCrv] `json:"crv"`
	// RSA exponent
	E param.Field[string] `json:"e"`
	// RSA modulus
	N param.Field[string] `json:"n"`
	// X EC coordinate
	X param.Field[string] `json:"x"`
	// Y EC coordinate
	Y param.Field[string] `json:"y"`
}

JSON representation of a JWKS key.

func (ConfigurationNewParamsCredentialsKey) MarshalJSON

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

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256 struct {
	// Algorithm
	Alg param.Field[ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg] `json:"alg,required"`
	// Curve
	Crv param.Field[ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv] `json:"crv,required"`
	// Key ID
	Kid param.Field[string] `json:"kid,required"`
	// Key Type
	Kty param.Field[ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty] `json:"kty,required"`
	// X EC coordinate
	X param.Field[string] `json:"x,required"`
	// Y EC coordinate
	Y param.Field[string] `json:"y,required"`
}

JSON representation of an ES256 key

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256) MarshalJSON

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg string

Algorithm

const (
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256AlgEs256 ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg = "ES256"
)

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg) IsKnown

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv string

Curve

const (
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256CrvP256 ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv = "P-256"
)

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv) IsKnown

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty string

Key Type

const (
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256KtyEc ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty = "EC"
)

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty) IsKnown

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384 struct {
	// Algorithm
	Alg param.Field[ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg] `json:"alg,required"`
	// Curve
	Crv param.Field[ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv] `json:"crv,required"`
	// Key ID
	Kid param.Field[string] `json:"kid,required"`
	// Key Type
	Kty param.Field[ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty] `json:"kty,required"`
	// X EC coordinate
	X param.Field[string] `json:"x,required"`
	// Y EC coordinate
	Y param.Field[string] `json:"y,required"`
}

JSON representation of an ES384 key

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384) MarshalJSON

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg string

Algorithm

const (
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384AlgEs384 ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg = "ES384"
)

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg) IsKnown

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv string

Curve

const (
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384CrvP384 ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv = "P-384"
)

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv) IsKnown

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty string

Key Type

const (
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384KtyEc ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty = "EC"
)

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty) IsKnown

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSA

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSA struct {
	// Algorithm
	Alg param.Field[ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg] `json:"alg,required"`
	// RSA exponent
	E param.Field[string] `json:"e,required"`
	// Key ID
	Kid param.Field[string] `json:"kid,required"`
	// Key Type
	Kty param.Field[ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty] `json:"kty,required"`
	// RSA modulus
	N param.Field[string] `json:"n,required"`
}

JSON representation of an RSA key.

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSA) MarshalJSON

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg string

Algorithm

const (
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgRs256 ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS256"
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgRs384 ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS384"
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgRs512 ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS512"
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgPs256 ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS256"
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgPs384 ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS384"
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgPs512 ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS512"
)

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg) IsKnown

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty

type ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty string

Key Type

const (
	ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAKtyRSA ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty = "RSA"
)

func (ConfigurationNewParamsCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty) IsKnown

type ConfigurationNewParamsCredentialsKeysAlg

type ConfigurationNewParamsCredentialsKeysAlg string

Algorithm

const (
	ConfigurationNewParamsCredentialsKeysAlgRs256 ConfigurationNewParamsCredentialsKeysAlg = "RS256"
	ConfigurationNewParamsCredentialsKeysAlgRs384 ConfigurationNewParamsCredentialsKeysAlg = "RS384"
	ConfigurationNewParamsCredentialsKeysAlgRs512 ConfigurationNewParamsCredentialsKeysAlg = "RS512"
	ConfigurationNewParamsCredentialsKeysAlgPs256 ConfigurationNewParamsCredentialsKeysAlg = "PS256"
	ConfigurationNewParamsCredentialsKeysAlgPs384 ConfigurationNewParamsCredentialsKeysAlg = "PS384"
	ConfigurationNewParamsCredentialsKeysAlgPs512 ConfigurationNewParamsCredentialsKeysAlg = "PS512"
	ConfigurationNewParamsCredentialsKeysAlgEs256 ConfigurationNewParamsCredentialsKeysAlg = "ES256"
	ConfigurationNewParamsCredentialsKeysAlgEs384 ConfigurationNewParamsCredentialsKeysAlg = "ES384"
)

func (ConfigurationNewParamsCredentialsKeysAlg) IsKnown

type ConfigurationNewParamsCredentialsKeysCrv

type ConfigurationNewParamsCredentialsKeysCrv string

Curve

const (
	ConfigurationNewParamsCredentialsKeysCrvP256 ConfigurationNewParamsCredentialsKeysCrv = "P-256"
	ConfigurationNewParamsCredentialsKeysCrvP384 ConfigurationNewParamsCredentialsKeysCrv = "P-384"
)

func (ConfigurationNewParamsCredentialsKeysCrv) IsKnown

type ConfigurationNewParamsCredentialsKeysKty

type ConfigurationNewParamsCredentialsKeysKty string

Key Type

const (
	ConfigurationNewParamsCredentialsKeysKtyRSA ConfigurationNewParamsCredentialsKeysKty = "RSA"
	ConfigurationNewParamsCredentialsKeysKtyEc  ConfigurationNewParamsCredentialsKeysKty = "EC"
)

func (ConfigurationNewParamsCredentialsKeysKty) IsKnown

type ConfigurationNewParamsTokenType

type ConfigurationNewParamsTokenType string
const (
	ConfigurationNewParamsTokenTypeJWT ConfigurationNewParamsTokenType = "JWT"
)

func (ConfigurationNewParamsTokenType) IsKnown

type ConfigurationNewResponseEnvelope

type ConfigurationNewResponseEnvelope struct {
	Errors   api_gateway.Message `json:"errors,required"`
	Messages api_gateway.Message `json:"messages,required"`
	Result   TokenConfig         `json:"result,required"`
	// Whether the API call was successful.
	Success ConfigurationNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    configurationNewResponseEnvelopeJSON    `json:"-"`
}

func (*ConfigurationNewResponseEnvelope) UnmarshalJSON

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

type ConfigurationNewResponseEnvelopeSuccess

type ConfigurationNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ConfigurationNewResponseEnvelopeSuccessTrue ConfigurationNewResponseEnvelopeSuccess = true
)

func (ConfigurationNewResponseEnvelopeSuccess) IsKnown

type ConfigurationService

type ConfigurationService struct {
	Options     []option.RequestOption
	Credentials *ConfigurationCredentialService
}

ConfigurationService 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 NewConfigurationService method instead.

func NewConfigurationService

func NewConfigurationService(opts ...option.RequestOption) (r *ConfigurationService)

NewConfigurationService 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 (*ConfigurationService) Delete

Delete Token Configuration

func (*ConfigurationService) Edit

Edit fields of an existing Token Configuration

func (*ConfigurationService) Get

func (r *ConfigurationService) Get(ctx context.Context, configID string, query ConfigurationGetParams, opts ...option.RequestOption) (res *TokenConfig, err error)

Get a single Token Configuration

func (*ConfigurationService) List

Lists all token validation configurations for this zone

func (*ConfigurationService) ListAutoPaging

Lists all token validation configurations for this zone

func (*ConfigurationService) New

Create a new Token Validation configuration

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 RuleBulkEditParams

type RuleBulkEditParams struct {
	// Identifier.
	ZoneID param.Field[string]      `path:"zone_id,required"`
	Body   []RuleBulkEditParamsBody `json:"body,required"`
}

func (RuleBulkEditParams) MarshalJSON

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

type RuleBulkEditParamsBody

type RuleBulkEditParamsBody struct {
	// Rule ID this patch applies to
	ID param.Field[string] `json:"id,required" format:"uuid"`
	// Action to take on requests that match operations included in `selector` and fail
	// `expression`.
	Action param.Field[RuleBulkEditParamsBodyAction] `json:"action"`
	// A human-readable description that gives more details than `title`.
	Description param.Field[string] `json:"description"`
	// Toggle rule on or off.
	Enabled param.Field[bool] `json:"enabled"`
	// Rule expression. Requests that fail to match this expression will be subject to
	// `action`.
	//
	// For details on expressions, see the
	// [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).
	Expression param.Field[string] `json:"expression"`
	// Update rule order among zone rules.
	Position param.Field[RuleBulkEditParamsBodyPositionUnion] `json:"position"`
	// Select operations covered by this rule.
	//
	// For details on selectors, see the
	// [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).
	Selector param.Field[RuleBulkEditParamsBodySelector] `json:"selector"`
	// A human-readable name for the rule.
	Title param.Field[string] `json:"title"`
}

func (RuleBulkEditParamsBody) MarshalJSON

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

type RuleBulkEditParamsBodyAction

type RuleBulkEditParamsBodyAction string

Action to take on requests that match operations included in `selector` and fail `expression`.

const (
	RuleBulkEditParamsBodyActionLog   RuleBulkEditParamsBodyAction = "log"
	RuleBulkEditParamsBodyActionBlock RuleBulkEditParamsBodyAction = "block"
)

func (RuleBulkEditParamsBodyAction) IsKnown

func (r RuleBulkEditParamsBodyAction) IsKnown() bool

type RuleBulkEditParamsBodyPosition

type RuleBulkEditParamsBodyPosition struct {
	// Move rule to after rule with this ID.
	After param.Field[string] `json:"after" format:"uuid"`
	// Move rule to before rule with this ID.
	Before param.Field[string] `json:"before" format:"uuid"`
	// Move rule to this position
	Index param.Field[int64] `json:"index"`
}

Update rule order among zone rules.

func (RuleBulkEditParamsBodyPosition) MarshalJSON

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

type RuleBulkEditParamsBodyPositionAPIShieldAfter

type RuleBulkEditParamsBodyPositionAPIShieldAfter struct {
	// Move rule to after rule with this ID.
	After param.Field[string] `json:"after" format:"uuid"`
}

Move rule to before rule with ID.

func (RuleBulkEditParamsBodyPositionAPIShieldAfter) MarshalJSON

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

type RuleBulkEditParamsBodyPositionAPIShieldBefore

type RuleBulkEditParamsBodyPositionAPIShieldBefore struct {
	// Move rule to before rule with this ID.
	Before param.Field[string] `json:"before" format:"uuid"`
}

Move rule to after rule with ID.

func (RuleBulkEditParamsBodyPositionAPIShieldBefore) MarshalJSON

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

type RuleBulkEditParamsBodyPositionAPIShieldIndex

type RuleBulkEditParamsBodyPositionAPIShieldIndex struct {
	// Move rule to this position
	Index param.Field[int64] `json:"index,required"`
}

func (RuleBulkEditParamsBodyPositionAPIShieldIndex) MarshalJSON

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

type RuleBulkEditParamsBodySelector

type RuleBulkEditParamsBodySelector struct {
	// Ignore operations that were otherwise included by `include`.
	Exclude param.Field[[]RuleBulkEditParamsBodySelectorExclude] `json:"exclude"`
	// Select all matching operations.
	Include param.Field[[]RuleBulkEditParamsBodySelectorInclude] `json:"include"`
}

Select operations covered by this rule.

For details on selectors, see the [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).

func (RuleBulkEditParamsBodySelector) MarshalJSON

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

type RuleBulkEditParamsBodySelectorExclude

type RuleBulkEditParamsBodySelectorExclude struct {
	// Excluded operation IDs.
	OperationIDs param.Field[[]string] `json:"operation_ids"`
}

func (RuleBulkEditParamsBodySelectorExclude) MarshalJSON

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

type RuleBulkEditParamsBodySelectorInclude

type RuleBulkEditParamsBodySelectorInclude struct {
	// Included hostnames.
	Host param.Field[[]string] `json:"host" format:"hostname"`
}

func (RuleBulkEditParamsBodySelectorInclude) MarshalJSON

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

type RuleBulkNewParams

type RuleBulkNewParams struct {
	// Identifier.
	ZoneID param.Field[string]     `path:"zone_id,required"`
	Body   []RuleBulkNewParamsBody `json:"body,required"`
}

func (RuleBulkNewParams) MarshalJSON

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

type RuleBulkNewParamsBody

type RuleBulkNewParamsBody struct {
	// Action to take on requests that match operations included in `selector` and fail
	// `expression`.
	Action param.Field[RuleBulkNewParamsBodyAction] `json:"action,required"`
	// A human-readable description that gives more details than `title`.
	Description param.Field[string] `json:"description,required"`
	// Toggle rule on or off.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Rule expression. Requests that fail to match this expression will be subject to
	// `action`.
	//
	// For details on expressions, see the
	// [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).
	Expression param.Field[string] `json:"expression,required"`
	// Select operations covered by this rule.
	//
	// For details on selectors, see the
	// [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).
	Selector param.Field[RuleBulkNewParamsBodySelector] `json:"selector,required"`
	// A human-readable name for the rule.
	Title param.Field[string] `json:"title,required"`
}

A Token Validation rule that can enforce security policies using JWT Tokens.

func (RuleBulkNewParamsBody) MarshalJSON

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

type RuleBulkNewParamsBodyAction

type RuleBulkNewParamsBodyAction string

Action to take on requests that match operations included in `selector` and fail `expression`.

const (
	RuleBulkNewParamsBodyActionLog   RuleBulkNewParamsBodyAction = "log"
	RuleBulkNewParamsBodyActionBlock RuleBulkNewParamsBodyAction = "block"
)

func (RuleBulkNewParamsBodyAction) IsKnown

func (r RuleBulkNewParamsBodyAction) IsKnown() bool

type RuleBulkNewParamsBodySelector

type RuleBulkNewParamsBodySelector struct {
	// Ignore operations that were otherwise included by `include`.
	Exclude param.Field[[]RuleBulkNewParamsBodySelectorExclude] `json:"exclude"`
	// Select all matching operations.
	Include param.Field[[]RuleBulkNewParamsBodySelectorInclude] `json:"include"`
}

Select operations covered by this rule.

For details on selectors, see the [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).

func (RuleBulkNewParamsBodySelector) MarshalJSON

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

type RuleBulkNewParamsBodySelectorExclude

type RuleBulkNewParamsBodySelectorExclude struct {
	// Excluded operation IDs.
	OperationIDs param.Field[[]string] `json:"operation_ids"`
}

func (RuleBulkNewParamsBodySelectorExclude) MarshalJSON

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

type RuleBulkNewParamsBodySelectorInclude

type RuleBulkNewParamsBodySelectorInclude struct {
	// Included hostnames.
	Host param.Field[[]string] `json:"host" format:"hostname"`
}

func (RuleBulkNewParamsBodySelectorInclude) MarshalJSON

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

type RuleDeleteParams

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

type RuleDeleteResponse

type RuleDeleteResponse = interface{}

type RuleDeleteResponseEnvelope

type RuleDeleteResponseEnvelope struct {
	Errors   api_gateway.Message `json:"errors,required"`
	Messages api_gateway.Message `json:"messages,required"`
	// Whether the API call was successful.
	Success RuleDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  RuleDeleteResponse                `json:"result"`
	JSON    ruleDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*RuleDeleteResponseEnvelope) UnmarshalJSON

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

type RuleDeleteResponseEnvelopeSuccess

type RuleDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RuleDeleteResponseEnvelopeSuccessTrue RuleDeleteResponseEnvelopeSuccess = true
)

func (RuleDeleteResponseEnvelopeSuccess) IsKnown

type RuleEditParams

type RuleEditParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Action to take on requests that match operations included in `selector` and fail
	// `expression`.
	Action param.Field[RuleEditParamsAction] `json:"action"`
	// A human-readable description that gives more details than `title`.
	Description param.Field[string] `json:"description"`
	// Toggle rule on or off.
	Enabled param.Field[bool] `json:"enabled"`
	// Rule expression. Requests that fail to match this expression will be subject to
	// `action`.
	//
	// For details on expressions, see the
	// [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).
	Expression param.Field[string] `json:"expression"`
	// Update rule order among zone rules.
	Position param.Field[RuleEditParamsPositionUnion] `json:"position"`
	// Select operations covered by this rule.
	//
	// For details on selectors, see the
	// [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).
	Selector param.Field[RuleEditParamsSelector] `json:"selector"`
	// A human-readable name for the rule.
	Title param.Field[string] `json:"title"`
}

func (RuleEditParams) MarshalJSON

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

type RuleEditParamsAction

type RuleEditParamsAction string

Action to take on requests that match operations included in `selector` and fail `expression`.

const (
	RuleEditParamsActionLog   RuleEditParamsAction = "log"
	RuleEditParamsActionBlock RuleEditParamsAction = "block"
)

func (RuleEditParamsAction) IsKnown

func (r RuleEditParamsAction) IsKnown() bool

type RuleEditParamsPosition

type RuleEditParamsPosition struct {
	// Move rule to after rule with this ID.
	After param.Field[string] `json:"after" format:"uuid"`
	// Move rule to before rule with this ID.
	Before param.Field[string] `json:"before" format:"uuid"`
	// Move rule to this position
	Index param.Field[int64] `json:"index"`
}

Update rule order among zone rules.

func (RuleEditParamsPosition) MarshalJSON

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

type RuleEditParamsPositionAPIShieldAfter

type RuleEditParamsPositionAPIShieldAfter struct {
	// Move rule to after rule with this ID.
	After param.Field[string] `json:"after" format:"uuid"`
}

Move rule to before rule with ID.

func (RuleEditParamsPositionAPIShieldAfter) MarshalJSON

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

type RuleEditParamsPositionAPIShieldBefore

type RuleEditParamsPositionAPIShieldBefore struct {
	// Move rule to before rule with this ID.
	Before param.Field[string] `json:"before" format:"uuid"`
}

Move rule to after rule with ID.

func (RuleEditParamsPositionAPIShieldBefore) MarshalJSON

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

type RuleEditParamsPositionAPIShieldIndex

type RuleEditParamsPositionAPIShieldIndex struct {
	// Move rule to this position
	Index param.Field[int64] `json:"index,required"`
}

func (RuleEditParamsPositionAPIShieldIndex) MarshalJSON

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

type RuleEditParamsPositionUnion

type RuleEditParamsPositionUnion interface {
	// contains filtered or unexported methods
}

Update rule order among zone rules.

Satisfied by token_validation.RuleEditParamsPositionAPIShieldIndex, token_validation.RuleEditParamsPositionAPIShieldBefore, token_validation.RuleEditParamsPositionAPIShieldAfter, RuleEditParamsPosition.

type RuleEditParamsSelector

type RuleEditParamsSelector struct {
	// Ignore operations that were otherwise included by `include`.
	Exclude param.Field[[]RuleEditParamsSelectorExclude] `json:"exclude"`
	// Select all matching operations.
	Include param.Field[[]RuleEditParamsSelectorInclude] `json:"include"`
}

Select operations covered by this rule.

For details on selectors, see the [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).

func (RuleEditParamsSelector) MarshalJSON

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

type RuleEditParamsSelectorExclude

type RuleEditParamsSelectorExclude struct {
	// Excluded operation IDs.
	OperationIDs param.Field[[]string] `json:"operation_ids"`
}

func (RuleEditParamsSelectorExclude) MarshalJSON

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

type RuleEditParamsSelectorInclude

type RuleEditParamsSelectorInclude struct {
	// Included hostnames.
	Host param.Field[[]string] `json:"host" format:"hostname"`
}

func (RuleEditParamsSelectorInclude) MarshalJSON

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

type RuleEditResponseEnvelope

type RuleEditResponseEnvelope struct {
	Errors   api_gateway.Message `json:"errors,required"`
	Messages api_gateway.Message `json:"messages,required"`
	// A Token Validation rule that can enforce security policies using JWT Tokens.
	Result TokenValidationRule `json:"result,required"`
	// Whether the API call was successful.
	Success RuleEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    ruleEditResponseEnvelopeJSON    `json:"-"`
}

func (*RuleEditResponseEnvelope) UnmarshalJSON

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

type RuleEditResponseEnvelopeSuccess

type RuleEditResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RuleEditResponseEnvelopeSuccessTrue RuleEditResponseEnvelopeSuccess = true
)

func (RuleEditResponseEnvelopeSuccess) IsKnown

type RuleGetParams

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

type RuleGetResponseEnvelope

type RuleGetResponseEnvelope struct {
	Errors   api_gateway.Message `json:"errors,required"`
	Messages api_gateway.Message `json:"messages,required"`
	// A Token Validation rule that can enforce security policies using JWT Tokens.
	Result TokenValidationRule `json:"result,required"`
	// Whether the API call was successful.
	Success RuleGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    ruleGetResponseEnvelopeJSON    `json:"-"`
}

func (*RuleGetResponseEnvelope) UnmarshalJSON

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

type RuleGetResponseEnvelopeSuccess

type RuleGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RuleGetResponseEnvelopeSuccessTrue RuleGetResponseEnvelopeSuccess = true
)

func (RuleGetResponseEnvelopeSuccess) IsKnown

type RuleListParams

type RuleListParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Select rules with these IDs.
	ID param.Field[string] `query:"id"`
	// Action to take on requests that match operations included in `selector` and fail
	// `expression`.
	Action param.Field[RuleListParamsAction] `query:"action"`
	// Toggle rule on or off.
	Enabled param.Field[bool] `query:"enabled"`
	// Select rules with this host in `include`.
	Host param.Field[string] `query:"host" format:"hostname"`
	// Select rules with this host in `include`.
	Hostname param.Field[string] `query:"hostname" format:"hostname"`
	// Page number of paginated results.
	Page param.Field[int64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// Select rules with these IDs.
	RuleID param.Field[string] `query:"rule_id"`
	// Select rules using any of these token configurations.
	TokenConfiguration param.Field[[]string] `query:"token_configuration"`
}

func (RuleListParams) URLQuery

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

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

type RuleListParamsAction

type RuleListParamsAction string

Action to take on requests that match operations included in `selector` and fail `expression`.

const (
	RuleListParamsActionLog   RuleListParamsAction = "log"
	RuleListParamsActionBlock RuleListParamsAction = "block"
)

func (RuleListParamsAction) IsKnown

func (r RuleListParamsAction) IsKnown() bool

type RuleNewParams

type RuleNewParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Action to take on requests that match operations included in `selector` and fail
	// `expression`.
	Action param.Field[RuleNewParamsAction] `json:"action,required"`
	// A human-readable description that gives more details than `title`.
	Description param.Field[string] `json:"description,required"`
	// Toggle rule on or off.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Rule expression. Requests that fail to match this expression will be subject to
	// `action`.
	//
	// For details on expressions, see the
	// [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).
	Expression param.Field[string] `json:"expression,required"`
	// Select operations covered by this rule.
	//
	// For details on selectors, see the
	// [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).
	Selector param.Field[RuleNewParamsSelector] `json:"selector,required"`
	// A human-readable name for the rule.
	Title param.Field[string] `json:"title,required"`
}

func (RuleNewParams) MarshalJSON

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

type RuleNewParamsAction

type RuleNewParamsAction string

Action to take on requests that match operations included in `selector` and fail `expression`.

const (
	RuleNewParamsActionLog   RuleNewParamsAction = "log"
	RuleNewParamsActionBlock RuleNewParamsAction = "block"
)

func (RuleNewParamsAction) IsKnown

func (r RuleNewParamsAction) IsKnown() bool

type RuleNewParamsSelector

type RuleNewParamsSelector struct {
	// Ignore operations that were otherwise included by `include`.
	Exclude param.Field[[]RuleNewParamsSelectorExclude] `json:"exclude"`
	// Select all matching operations.
	Include param.Field[[]RuleNewParamsSelectorInclude] `json:"include"`
}

Select operations covered by this rule.

For details on selectors, see the [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).

func (RuleNewParamsSelector) MarshalJSON

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

type RuleNewParamsSelectorExclude

type RuleNewParamsSelectorExclude struct {
	// Excluded operation IDs.
	OperationIDs param.Field[[]string] `json:"operation_ids"`
}

func (RuleNewParamsSelectorExclude) MarshalJSON

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

type RuleNewParamsSelectorInclude

type RuleNewParamsSelectorInclude struct {
	// Included hostnames.
	Host param.Field[[]string] `json:"host" format:"hostname"`
}

func (RuleNewParamsSelectorInclude) MarshalJSON

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

type RuleNewResponseEnvelope

type RuleNewResponseEnvelope struct {
	Errors   api_gateway.Message `json:"errors,required"`
	Messages api_gateway.Message `json:"messages,required"`
	// A Token Validation rule that can enforce security policies using JWT Tokens.
	Result TokenValidationRule `json:"result,required"`
	// Whether the API call was successful.
	Success RuleNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    ruleNewResponseEnvelopeJSON    `json:"-"`
}

func (*RuleNewResponseEnvelope) UnmarshalJSON

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

type RuleNewResponseEnvelopeSuccess

type RuleNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RuleNewResponseEnvelopeSuccessTrue RuleNewResponseEnvelopeSuccess = true
)

func (RuleNewResponseEnvelopeSuccess) IsKnown

type RuleService

type RuleService struct {
	Options []option.RequestOption
}

RuleService 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 NewRuleService method instead.

func NewRuleService

func NewRuleService(opts ...option.RequestOption) (r *RuleService)

NewRuleService 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 (*RuleService) BulkEdit

Edit token validation rules.

A request can update multiple Token Validation Rules.

Rules can be re-ordered using the `position` field.

Returns all updated rules.

func (*RuleService) BulkEditAutoPaging

Edit token validation rules.

A request can update multiple Token Validation Rules.

Rules can be re-ordered using the `position` field.

Returns all updated rules.

func (*RuleService) BulkNew

Create zone token validation rules.

A request can create multiple Token Validation Rules.

func (*RuleService) BulkNewAutoPaging

Create zone token validation rules.

A request can create multiple Token Validation Rules.

func (*RuleService) Delete

func (r *RuleService) Delete(ctx context.Context, ruleID string, body RuleDeleteParams, opts ...option.RequestOption) (res *RuleDeleteResponse, err error)

Delete a zone token validation rule.

func (*RuleService) Edit

func (r *RuleService) Edit(ctx context.Context, ruleID string, params RuleEditParams, opts ...option.RequestOption) (res *TokenValidationRule, err error)

Edit a zone token validation rule.

func (*RuleService) Get

func (r *RuleService) Get(ctx context.Context, ruleID string, query RuleGetParams, opts ...option.RequestOption) (res *TokenValidationRule, err error)

Get a zone token validation rule.

func (*RuleService) List

List token validation rules

func (*RuleService) ListAutoPaging

List token validation rules

func (*RuleService) New

func (r *RuleService) New(ctx context.Context, params RuleNewParams, opts ...option.RequestOption) (res *TokenValidationRule, err error)

Create a token validation rule.

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 TokenConfig

type TokenConfig struct {
	// UUID.
	ID           string                 `json:"id,required"`
	CreatedAt    time.Time              `json:"created_at,required" format:"date-time"`
	Credentials  TokenConfigCredentials `json:"credentials,required"`
	Description  string                 `json:"description,required"`
	LastUpdated  time.Time              `json:"last_updated,required" format:"date-time"`
	Title        string                 `json:"title,required"`
	TokenSources []string               `json:"token_sources,required"`
	TokenType    TokenConfigTokenType   `json:"token_type,required"`
	JSON         tokenConfigJSON        `json:"-"`
}

func (*TokenConfig) UnmarshalJSON

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

type TokenConfigCredentials

type TokenConfigCredentials struct {
	Keys []TokenConfigCredentialsKey `json:"keys,required"`
	JSON tokenConfigCredentialsJSON  `json:"-"`
}

func (*TokenConfigCredentials) UnmarshalJSON

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

type TokenConfigCredentialsKey

type TokenConfigCredentialsKey struct {
	// Algorithm
	Alg TokenConfigCredentialsKeysAlg `json:"alg,required"`
	// Key ID
	Kid string `json:"kid,required"`
	// Key Type
	Kty TokenConfigCredentialsKeysKty `json:"kty,required"`
	// Curve
	Crv TokenConfigCredentialsKeysCrv `json:"crv"`
	// RSA exponent
	E string `json:"e"`
	// RSA modulus
	N string `json:"n"`
	// X EC coordinate
	X string `json:"x"`
	// Y EC coordinate
	Y    string                        `json:"y"`
	JSON tokenConfigCredentialsKeyJSON `json:"-"`
	// contains filtered or unexported fields
}

JSON representation of a JWKS key.

func (TokenConfigCredentialsKey) AsUnion

AsUnion returns a TokenConfigCredentialsKeysUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSA, TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256, TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384.

func (*TokenConfigCredentialsKey) UnmarshalJSON

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

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256 struct {
	// Algorithm
	Alg TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg `json:"alg,required"`
	// Curve
	Crv TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv `json:"crv,required"`
	// Key ID
	Kid string `json:"kid,required"`
	// Key Type
	Kty TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty `json:"kty,required"`
	// X EC coordinate
	X string `json:"x,required"`
	// Y EC coordinate
	Y    string                                                          `json:"y,required"`
	JSON tokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256JSON `json:"-"`
}

JSON representation of an ES256 key

func (*TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256) UnmarshalJSON

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg string

Algorithm

const (
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256AlgEs256 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg = "ES256"
)

func (TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg) IsKnown

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv string

Curve

const (
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256CrvP256 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv = "P-256"
)

func (TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv) IsKnown

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty string

Key Type

const (
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256KtyEc TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty = "EC"
)

func (TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty) IsKnown

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384 struct {
	// Algorithm
	Alg TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg `json:"alg,required"`
	// Curve
	Crv TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv `json:"crv,required"`
	// Key ID
	Kid string `json:"kid,required"`
	// Key Type
	Kty TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty `json:"kty,required"`
	// X EC coordinate
	X string `json:"x,required"`
	// Y EC coordinate
	Y    string                                                          `json:"y,required"`
	JSON tokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384JSON `json:"-"`
}

JSON representation of an ES384 key

func (*TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384) UnmarshalJSON

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg string

Algorithm

const (
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384AlgEs384 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg = "ES384"
)

func (TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg) IsKnown

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv string

Curve

const (
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384CrvP384 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv = "P-384"
)

func (TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv) IsKnown

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty string

Key Type

const (
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384KtyEc TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty = "EC"
)

func (TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty) IsKnown

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSA

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSA struct {
	// Algorithm
	Alg TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg `json:"alg,required"`
	// RSA exponent
	E string `json:"e,required"`
	// Key ID
	Kid string `json:"kid,required"`
	// Key Type
	Kty TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty `json:"kty,required"`
	// RSA modulus
	N    string                                                      `json:"n,required"`
	JSON tokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAJSON `json:"-"`
}

JSON representation of an RSA key.

func (*TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSA) UnmarshalJSON

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg string

Algorithm

const (
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgRs256 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS256"
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgRs384 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS384"
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgRs512 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS512"
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgPs256 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS256"
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgPs384 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS384"
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgPs512 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS512"
)

func (TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg) IsKnown

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty string

Key Type

const (
	TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAKtyRSA TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty = "RSA"
)

func (TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty) IsKnown

type TokenConfigCredentialsKeysAlg

type TokenConfigCredentialsKeysAlg string

Algorithm

const (
	TokenConfigCredentialsKeysAlgRs256 TokenConfigCredentialsKeysAlg = "RS256"
	TokenConfigCredentialsKeysAlgRs384 TokenConfigCredentialsKeysAlg = "RS384"
	TokenConfigCredentialsKeysAlgRs512 TokenConfigCredentialsKeysAlg = "RS512"
	TokenConfigCredentialsKeysAlgPs256 TokenConfigCredentialsKeysAlg = "PS256"
	TokenConfigCredentialsKeysAlgPs384 TokenConfigCredentialsKeysAlg = "PS384"
	TokenConfigCredentialsKeysAlgPs512 TokenConfigCredentialsKeysAlg = "PS512"
	TokenConfigCredentialsKeysAlgEs256 TokenConfigCredentialsKeysAlg = "ES256"
	TokenConfigCredentialsKeysAlgEs384 TokenConfigCredentialsKeysAlg = "ES384"
)

func (TokenConfigCredentialsKeysAlg) IsKnown

func (r TokenConfigCredentialsKeysAlg) IsKnown() bool

type TokenConfigCredentialsKeysCrv

type TokenConfigCredentialsKeysCrv string

Curve

const (
	TokenConfigCredentialsKeysCrvP256 TokenConfigCredentialsKeysCrv = "P-256"
	TokenConfigCredentialsKeysCrvP384 TokenConfigCredentialsKeysCrv = "P-384"
)

func (TokenConfigCredentialsKeysCrv) IsKnown

func (r TokenConfigCredentialsKeysCrv) IsKnown() bool

type TokenConfigCredentialsKeysKty

type TokenConfigCredentialsKeysKty string

Key Type

const (
	TokenConfigCredentialsKeysKtyRSA TokenConfigCredentialsKeysKty = "RSA"
	TokenConfigCredentialsKeysKtyEc  TokenConfigCredentialsKeysKty = "EC"
)

func (TokenConfigCredentialsKeysKty) IsKnown

func (r TokenConfigCredentialsKeysKty) IsKnown() bool

type TokenConfigCredentialsKeysUnion

type TokenConfigCredentialsKeysUnion interface {
	// contains filtered or unexported methods
}

JSON representation of a JWKS key.

Union satisfied by TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSA, TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256 or TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384.

type TokenConfigTokenType

type TokenConfigTokenType string
const (
	TokenConfigTokenTypeJWT TokenConfigTokenType = "JWT"
)

func (TokenConfigTokenType) IsKnown

func (r TokenConfigTokenType) IsKnown() bool

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 TokenValidationRule

type TokenValidationRule struct {
	// Action to take on requests that match operations included in `selector` and fail
	// `expression`.
	Action TokenValidationRuleAction `json:"action,required"`
	// A human-readable description that gives more details than `title`.
	Description string `json:"description,required"`
	// Toggle rule on or off.
	Enabled bool `json:"enabled,required"`
	// Rule expression. Requests that fail to match this expression will be subject to
	// `action`.
	//
	// For details on expressions, see the
	// [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).
	Expression string `json:"expression,required"`
	// Select operations covered by this rule.
	//
	// For details on selectors, see the
	// [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).
	Selector TokenValidationRuleSelector `json:"selector,required"`
	// A human-readable name for the rule.
	Title string `json:"title,required"`
	// UUID.
	ID          string                  `json:"id"`
	CreatedAt   time.Time               `json:"created_at" format:"date-time"`
	LastUpdated time.Time               `json:"last_updated" format:"date-time"`
	JSON        tokenValidationRuleJSON `json:"-"`
}

A Token Validation rule that can enforce security policies using JWT Tokens.

func (*TokenValidationRule) UnmarshalJSON

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

type TokenValidationRuleAction

type TokenValidationRuleAction string

Action to take on requests that match operations included in `selector` and fail `expression`.

const (
	TokenValidationRuleActionLog   TokenValidationRuleAction = "log"
	TokenValidationRuleActionBlock TokenValidationRuleAction = "block"
)

func (TokenValidationRuleAction) IsKnown

func (r TokenValidationRuleAction) IsKnown() bool

type TokenValidationRuleSelector

type TokenValidationRuleSelector struct {
	// Ignore operations that were otherwise included by `include`.
	Exclude []TokenValidationRuleSelectorExclude `json:"exclude,nullable"`
	// Select all matching operations.
	Include []TokenValidationRuleSelectorInclude `json:"include,nullable"`
	JSON    tokenValidationRuleSelectorJSON      `json:"-"`
}

Select operations covered by this rule.

For details on selectors, see the [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).

func (*TokenValidationRuleSelector) UnmarshalJSON

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

type TokenValidationRuleSelectorExclude

type TokenValidationRuleSelectorExclude struct {
	// Excluded operation IDs.
	OperationIDs []string                               `json:"operation_ids"`
	JSON         tokenValidationRuleSelectorExcludeJSON `json:"-"`
}

func (*TokenValidationRuleSelectorExclude) UnmarshalJSON

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

type TokenValidationRuleSelectorInclude

type TokenValidationRuleSelectorInclude struct {
	// Included hostnames.
	Host []string                               `json:"host" format:"hostname"`
	JSON tokenValidationRuleSelectorIncludeJSON `json:"-"`
}

func (*TokenValidationRuleSelectorInclude) UnmarshalJSON

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

type TokenValidationService

type TokenValidationService struct {
	Options       []option.RequestOption
	Configuration *ConfigurationService
	Rules         *RuleService
}

TokenValidationService 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 NewTokenValidationService method instead.

func NewTokenValidationService

func NewTokenValidationService(opts ...option.RequestOption) (r *TokenValidationService)

NewTokenValidationService 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 TokenValue

type TokenValue = shared.TokenValue

The token value.

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