csam_scanner

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 CsamScannerEditParams ¶

type CsamScannerEditParams struct {
	// Identifier for the zone.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
	// The feature identifier.
	ID param.Field[CsamScannerEditParamsID] `json:"id"`
	// Writable CSAM Scanner feature configuration values.
	Value param.Field[CsamScannerEditParamsValue] `json:"value"`
}

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

type CsamScannerEditParamsID ¶

type CsamScannerEditParamsID string

The feature identifier.

const (
	CsamScannerEditParamsIDCsamScanner CsamScannerEditParamsID = "csam_scanner"
)

func (r CsamScannerEditParamsID) IsKnown() bool

type CsamScannerEditParamsValue ¶

type CsamScannerEditParamsValue struct {
	// Notification email address for CSAM scan results. When changed, email
	// verification is triggered automatically.
	Email param.Field[string] `json:"email"`
	// Whether CSAM scanning is enabled for this zone.
	Enabled param.Field[bool] `json:"enabled"`
	// Set to true to trigger re-sending the email verification. Write-only; never
	// appears in responses (omitted when false).
	ResendEmail param.Field[bool] `json:"resend_email"`
	// Map of scanning sources and their enabled state.
	Sources param.Field[map[string]bool] `json:"sources"`
}

Writable CSAM Scanner feature configuration values.

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

type CsamScannerEditResponse ¶

type CsamScannerEditResponse struct {
	// The feature identifier.
	ID CsamScannerEditResponseID `json:"id"`
	// Whether the feature state can be changed. When false, the zone or account may be
	// locked by Trust & Safety.
	Editable bool `json:"editable"`
	// When the setting was last modified. Currently always null as the server does not
	// populate this field.
	ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
	// The CSAM Scanner feature configuration values. Contains the notification email
	// and scanning enablement settings.
	Value CsamScannerEditResponseValue `json:"value"`
	JSON  csamScannerEditResponseJSON  `json:"-"`
}

CSAM Scanner configuration for a zone.

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

type CsamScannerEditResponseEnvelope ¶

type CsamScannerEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors" api:"required"`
	Messages []shared.ResponseInfo `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success bool `json:"success" api:"required"`
	// CSAM Scanner configuration for a zone.
	Result CsamScannerEditResponse             `json:"result"`
	JSON   csamScannerEditResponseEnvelopeJSON `json:"-"`
}

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

type CsamScannerEditResponseID ¶

type CsamScannerEditResponseID string

The feature identifier.

const (
	CsamScannerEditResponseIDCsamScanner CsamScannerEditResponseID = "csam_scanner"
)

func (r CsamScannerEditResponseID) IsKnown() bool

type CsamScannerEditResponseValue ¶

type CsamScannerEditResponseValue struct {
	// Notification email address for CSAM scan results. Masked in responses unless
	// explicitly unmasked via admin endpoint.
	Email string `json:"email"`
	// Current verification state of the notification email.
	EmailState CsamScannerEditResponseValueEmailState `json:"email_state"`
	// Whether CSAM scanning is enabled for this zone.
	Enabled bool `json:"enabled"`
	// Map of scanning sources and their enabled state.
	Sources map[string]bool `json:"sources"`
	// The zone's plan level.
	ZonePlan string                           `json:"zone_plan"`
	JSON     csamScannerEditResponseValueJSON `json:"-"`
}

The CSAM Scanner feature configuration values. Contains the notification email and scanning enablement settings.

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

type CsamScannerEditResponseValueEmailState ¶

type CsamScannerEditResponseValueEmailState string

Current verification state of the notification email.

const (
	CsamScannerEditResponseValueEmailStateValid      CsamScannerEditResponseValueEmailState = "valid"
	CsamScannerEditResponseValueEmailStatePending    CsamScannerEditResponseValueEmailState = "pending"
	CsamScannerEditResponseValueEmailStateUnverified CsamScannerEditResponseValueEmailState = "unverified"
)

func (r CsamScannerEditResponseValueEmailState) IsKnown() bool

type CsamScannerGetParams ¶

type CsamScannerGetParams struct {
	// Identifier for the zone.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type CsamScannerGetResponse ¶

type CsamScannerGetResponse struct {
	// The feature identifier.
	ID CsamScannerGetResponseID `json:"id"`
	// Whether the feature state can be changed. When false, the zone or account may be
	// locked by Trust & Safety.
	Editable bool `json:"editable"`
	// When the setting was last modified. Currently always null as the server does not
	// populate this field.
	ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
	// The CSAM Scanner feature configuration values. Contains the notification email
	// and scanning enablement settings.
	Value CsamScannerGetResponseValue `json:"value"`
	JSON  csamScannerGetResponseJSON  `json:"-"`
}

CSAM Scanner configuration for a zone.

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

type CsamScannerGetResponseEnvelope ¶

type CsamScannerGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors" api:"required"`
	Messages []shared.ResponseInfo `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success bool `json:"success" api:"required"`
	// CSAM Scanner configuration for a zone.
	Result CsamScannerGetResponse             `json:"result"`
	JSON   csamScannerGetResponseEnvelopeJSON `json:"-"`
}

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

type CsamScannerGetResponseID ¶

type CsamScannerGetResponseID string

The feature identifier.

const (
	CsamScannerGetResponseIDCsamScanner CsamScannerGetResponseID = "csam_scanner"
)

func (r CsamScannerGetResponseID) IsKnown() bool

type CsamScannerGetResponseValue ¶

type CsamScannerGetResponseValue struct {
	// Notification email address for CSAM scan results. Masked in responses unless
	// explicitly unmasked via admin endpoint.
	Email string `json:"email"`
	// Current verification state of the notification email.
	EmailState CsamScannerGetResponseValueEmailState `json:"email_state"`
	// Whether CSAM scanning is enabled for this zone.
	Enabled bool `json:"enabled"`
	// Map of scanning sources and their enabled state.
	Sources map[string]bool `json:"sources"`
	// The zone's plan level.
	ZonePlan string                          `json:"zone_plan"`
	JSON     csamScannerGetResponseValueJSON `json:"-"`
}

The CSAM Scanner feature configuration values. Contains the notification email and scanning enablement settings.

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

type CsamScannerGetResponseValueEmailState ¶

type CsamScannerGetResponseValueEmailState string

Current verification state of the notification email.

const (
	CsamScannerGetResponseValueEmailStateValid      CsamScannerGetResponseValueEmailState = "valid"
	CsamScannerGetResponseValueEmailStatePending    CsamScannerGetResponseValueEmailState = "pending"
	CsamScannerGetResponseValueEmailStateUnverified CsamScannerGetResponseValueEmailState = "unverified"
)

func (r CsamScannerGetResponseValueEmailState) IsKnown() bool

type CsamScannerService ¶

type CsamScannerService struct {
	Options []option.RequestOption
}

CsamScannerService 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 NewCsamScannerService method instead.

func NewCsamScannerService(opts ...option.RequestOption) (r *CsamScannerService)

func (r *CsamScannerService) Edit(ctx context.Context, params CsamScannerEditParams, opts ...option.RequestOption) (res *CsamScannerEditResponse, err error)

func (r *CsamScannerService) Get(ctx context.Context, query CsamScannerGetParams, opts ...option.RequestOption) (res *CsamScannerGetResponse, err error)

type Error ¶

type Error = apierror.Error

type ErrorData ¶

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource ¶

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member ¶

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess ¶

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup ¶

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

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

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta ¶

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup ¶

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta ¶

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope ¶

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject ¶

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

type MemberPolicy ¶

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus ¶

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser ¶

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission ¶

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant ¶

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam ¶

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan ¶

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID ¶

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam ¶

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo ¶

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource ¶

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role ¶

type Role = shared.Role

This is an alias to an internal type.

type RoleParam ¶

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions ¶

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam ¶

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection ¶

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription ¶

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency ¶

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam ¶

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState ¶

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token ¶

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition ¶

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList ¶

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam ¶

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam ¶

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP ¶

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam ¶

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam ¶

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy ¶

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect ¶

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam ¶

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup ¶

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam ¶

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta ¶

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam ¶

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString ¶

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion ¶

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam ¶

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus ¶

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue ¶

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.