Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type CredentialSetCredentialDeleteParams
- type CredentialSetCredentialDeleteResponse
- type CredentialSetCredentialDeleteResponseEnvelope
- type CredentialSetCredentialDeleteResponseEnvelopeErrors
- type CredentialSetCredentialDeleteResponseEnvelopeErrorsSource
- type CredentialSetCredentialDeleteResponseEnvelopeMessages
- type CredentialSetCredentialDeleteResponseEnvelopeMessagesSource
- type CredentialSetCredentialDeleteResponseEnvelopeSuccess
- type CredentialSetCredentialEditParams
- type CredentialSetCredentialEditParamsLocation
- type CredentialSetCredentialEditResponse
- type CredentialSetCredentialEditResponseEnvelope
- type CredentialSetCredentialEditResponseEnvelopeErrors
- type CredentialSetCredentialEditResponseEnvelopeErrorsSource
- type CredentialSetCredentialEditResponseEnvelopeMessages
- type CredentialSetCredentialEditResponseEnvelopeMessagesSource
- type CredentialSetCredentialEditResponseEnvelopeSuccess
- type CredentialSetCredentialEditResponseLocation
- type CredentialSetCredentialGetParams
- type CredentialSetCredentialGetResponse
- type CredentialSetCredentialGetResponseEnvelope
- type CredentialSetCredentialGetResponseEnvelopeErrors
- type CredentialSetCredentialGetResponseEnvelopeErrorsSource
- type CredentialSetCredentialGetResponseEnvelopeMessages
- type CredentialSetCredentialGetResponseEnvelopeMessagesSource
- type CredentialSetCredentialGetResponseEnvelopeSuccess
- type CredentialSetCredentialGetResponseLocation
- type CredentialSetCredentialListParams
- type CredentialSetCredentialListResponse
- type CredentialSetCredentialListResponseLocation
- type CredentialSetCredentialNewParams
- type CredentialSetCredentialNewParamsLocation
- type CredentialSetCredentialNewResponse
- type CredentialSetCredentialNewResponseEnvelope
- type CredentialSetCredentialNewResponseEnvelopeErrors
- type CredentialSetCredentialNewResponseEnvelopeErrorsSource
- type CredentialSetCredentialNewResponseEnvelopeMessages
- type CredentialSetCredentialNewResponseEnvelopeMessagesSource
- type CredentialSetCredentialNewResponseEnvelopeSuccess
- type CredentialSetCredentialNewResponseLocation
- type CredentialSetCredentialService
- func (r *CredentialSetCredentialService) Delete(ctx context.Context, credentialSetID string, credentialID string, ...) (res *CredentialSetCredentialDeleteResponse, err error)
- func (r *CredentialSetCredentialService) Edit(ctx context.Context, credentialSetID string, credentialID string, ...) (res *CredentialSetCredentialEditResponse, err error)
- func (r *CredentialSetCredentialService) Get(ctx context.Context, credentialSetID string, credentialID string, ...) (res *CredentialSetCredentialGetResponse, err error)
- func (r *CredentialSetCredentialService) List(ctx context.Context, credentialSetID string, ...) (res *pagination.V4PagePaginationArray[CredentialSetCredentialListResponse], ...)
- func (r *CredentialSetCredentialService) ListAutoPaging(ctx context.Context, credentialSetID string, ...) ...
- func (r *CredentialSetCredentialService) New(ctx context.Context, credentialSetID string, ...) (res *CredentialSetCredentialNewResponse, err error)
- func (r *CredentialSetCredentialService) Update(ctx context.Context, credentialSetID string, credentialID string, ...) (res *CredentialSetCredentialUpdateResponse, err error)
- type CredentialSetCredentialUpdateParams
- type CredentialSetCredentialUpdateParamsLocation
- type CredentialSetCredentialUpdateResponse
- type CredentialSetCredentialUpdateResponseEnvelope
- type CredentialSetCredentialUpdateResponseEnvelopeErrors
- type CredentialSetCredentialUpdateResponseEnvelopeErrorsSource
- type CredentialSetCredentialUpdateResponseEnvelopeMessages
- type CredentialSetCredentialUpdateResponseEnvelopeMessagesSource
- type CredentialSetCredentialUpdateResponseEnvelopeSuccess
- type CredentialSetCredentialUpdateResponseLocation
- type CredentialSetDeleteParams
- type CredentialSetDeleteResponse
- type CredentialSetDeleteResponseEnvelope
- type CredentialSetDeleteResponseEnvelopeErrors
- type CredentialSetDeleteResponseEnvelopeErrorsSource
- type CredentialSetDeleteResponseEnvelopeMessages
- type CredentialSetDeleteResponseEnvelopeMessagesSource
- type CredentialSetDeleteResponseEnvelopeSuccess
- type CredentialSetEditParams
- type CredentialSetEditResponse
- type CredentialSetEditResponseEnvelope
- type CredentialSetEditResponseEnvelopeErrors
- type CredentialSetEditResponseEnvelopeErrorsSource
- type CredentialSetEditResponseEnvelopeMessages
- type CredentialSetEditResponseEnvelopeMessagesSource
- type CredentialSetEditResponseEnvelopeSuccess
- type CredentialSetGetParams
- type CredentialSetGetResponse
- type CredentialSetGetResponseEnvelope
- type CredentialSetGetResponseEnvelopeErrors
- type CredentialSetGetResponseEnvelopeErrorsSource
- type CredentialSetGetResponseEnvelopeMessages
- type CredentialSetGetResponseEnvelopeMessagesSource
- type CredentialSetGetResponseEnvelopeSuccess
- type CredentialSetListParams
- type CredentialSetListResponse
- type CredentialSetNewParams
- type CredentialSetNewResponse
- type CredentialSetNewResponseEnvelope
- type CredentialSetNewResponseEnvelopeErrors
- type CredentialSetNewResponseEnvelopeErrorsSource
- type CredentialSetNewResponseEnvelopeMessages
- type CredentialSetNewResponseEnvelopeMessagesSource
- type CredentialSetNewResponseEnvelopeSuccess
- type CredentialSetService
- func (r *CredentialSetService) Delete(ctx context.Context, credentialSetID string, body CredentialSetDeleteParams, ...) (res *CredentialSetDeleteResponse, err error)
- func (r *CredentialSetService) Edit(ctx context.Context, credentialSetID string, params CredentialSetEditParams, ...) (res *CredentialSetEditResponse, err error)
- func (r *CredentialSetService) Get(ctx context.Context, credentialSetID string, query CredentialSetGetParams, ...) (res *CredentialSetGetResponse, err error)
- func (r *CredentialSetService) List(ctx context.Context, params CredentialSetListParams, ...) (res *pagination.V4PagePaginationArray[CredentialSetListResponse], err error)
- func (r *CredentialSetService) ListAutoPaging(ctx context.Context, params CredentialSetListParams, ...) *pagination.V4PagePaginationArrayAutoPager[CredentialSetListResponse]
- func (r *CredentialSetService) New(ctx context.Context, params CredentialSetNewParams, ...) (res *CredentialSetNewResponse, err error)
- func (r *CredentialSetService) Update(ctx context.Context, credentialSetID string, params CredentialSetUpdateParams, ...) (res *CredentialSetUpdateResponse, err error)
- type CredentialSetUpdateParams
- type CredentialSetUpdateResponse
- type CredentialSetUpdateResponseEnvelope
- type CredentialSetUpdateResponseEnvelopeErrors
- type CredentialSetUpdateResponseEnvelopeErrorsSource
- type CredentialSetUpdateResponseEnvelopeMessages
- type CredentialSetUpdateResponseEnvelopeMessagesSource
- type CredentialSetUpdateResponseEnvelopeSuccess
- type Error
- type ErrorData
- type ErrorDataSource
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type ScanGetParams
- type ScanGetResponse
- type ScanGetResponseEnvelope
- type ScanGetResponseEnvelopeErrors
- type ScanGetResponseEnvelopeErrorsSource
- type ScanGetResponseEnvelopeMessages
- type ScanGetResponseEnvelopeMessagesSource
- type ScanGetResponseEnvelopeSuccess
- type ScanGetResponseReport
- type ScanGetResponseReportReport
- type ScanGetResponseReportReportSchemaVersion
- type ScanGetResponseReportReportSummary
- type ScanGetResponseReportReportSummaryVerdict
- type ScanGetResponseReportReportTest
- type ScanGetResponseReportReportTestsPreflightError
- type ScanGetResponseReportReportTestsStep
- type ScanGetResponseReportReportTestsStepsAssertion
- type ScanGetResponseReportReportTestsStepsAssertionsKind
- type ScanGetResponseReportReportTestsStepsAssertionsKindParameters
- type ScanGetResponseReportReportTestsStepsAssertionsKindType
- type ScanGetResponseReportReportTestsStepsAssertionsOutcome
- type ScanGetResponseReportReportTestsStepsError
- type ScanGetResponseReportReportTestsStepsRequest
- type ScanGetResponseReportReportTestsStepsRequestCredentialSet
- type ScanGetResponseReportReportTestsStepsRequestCredentialSetRole
- type ScanGetResponseReportReportTestsStepsRequestMethod
- type ScanGetResponseReportReportTestsStepsRequestVariableCapture
- type ScanGetResponseReportReportTestsStepsResponse
- type ScanGetResponseReportReportTestsStepsResponseBody
- type ScanGetResponseReportReportTestsStepsResponseBodyKind
- type ScanGetResponseReportReportTestsStepsResponseBodyUnion
- type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes
- type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind
- type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson
- type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind
- type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound
- type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind
- type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText
- type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind
- type ScanGetResponseReportReportTestsVerdict
- type ScanGetResponseScanType
- type ScanGetResponseStatus
- type ScanListParams
- type ScanListResponse
- type ScanListResponseReport
- type ScanListResponseReportReport
- type ScanListResponseReportReportSchemaVersion
- type ScanListResponseReportReportSummary
- type ScanListResponseReportReportSummaryVerdict
- type ScanListResponseReportReportTest
- type ScanListResponseReportReportTestsPreflightError
- type ScanListResponseReportReportTestsStep
- type ScanListResponseReportReportTestsStepsAssertion
- type ScanListResponseReportReportTestsStepsAssertionsKind
- type ScanListResponseReportReportTestsStepsAssertionsKindParameters
- type ScanListResponseReportReportTestsStepsAssertionsKindType
- type ScanListResponseReportReportTestsStepsAssertionsOutcome
- type ScanListResponseReportReportTestsStepsError
- type ScanListResponseReportReportTestsStepsRequest
- type ScanListResponseReportReportTestsStepsRequestCredentialSet
- type ScanListResponseReportReportTestsStepsRequestCredentialSetRole
- type ScanListResponseReportReportTestsStepsRequestMethod
- type ScanListResponseReportReportTestsStepsRequestVariableCapture
- type ScanListResponseReportReportTestsStepsResponse
- type ScanListResponseReportReportTestsStepsResponseBody
- type ScanListResponseReportReportTestsStepsResponseBodyKind
- type ScanListResponseReportReportTestsStepsResponseBodyUnion
- type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes
- type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind
- type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson
- type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind
- type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound
- type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind
- type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText
- type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind
- type ScanListResponseReportReportTestsVerdict
- type ScanListResponseScanType
- type ScanListResponseStatus
- type ScanNewParams
- type ScanNewParamsCredentialSets
- type ScanNewParamsScanType
- type ScanNewResponse
- type ScanNewResponseEnvelope
- type ScanNewResponseEnvelopeErrors
- type ScanNewResponseEnvelopeErrorsSource
- type ScanNewResponseEnvelopeMessages
- type ScanNewResponseEnvelopeMessagesSource
- type ScanNewResponseEnvelopeSuccess
- type ScanNewResponseReport
- type ScanNewResponseReportReport
- type ScanNewResponseReportReportSchemaVersion
- type ScanNewResponseReportReportSummary
- type ScanNewResponseReportReportSummaryVerdict
- type ScanNewResponseReportReportTest
- type ScanNewResponseReportReportTestsPreflightError
- type ScanNewResponseReportReportTestsStep
- type ScanNewResponseReportReportTestsStepsAssertion
- type ScanNewResponseReportReportTestsStepsAssertionsKind
- type ScanNewResponseReportReportTestsStepsAssertionsKindParameters
- type ScanNewResponseReportReportTestsStepsAssertionsKindType
- type ScanNewResponseReportReportTestsStepsAssertionsOutcome
- type ScanNewResponseReportReportTestsStepsError
- type ScanNewResponseReportReportTestsStepsRequest
- type ScanNewResponseReportReportTestsStepsRequestCredentialSet
- type ScanNewResponseReportReportTestsStepsRequestCredentialSetRole
- type ScanNewResponseReportReportTestsStepsRequestMethod
- type ScanNewResponseReportReportTestsStepsRequestVariableCapture
- type ScanNewResponseReportReportTestsStepsResponse
- type ScanNewResponseReportReportTestsStepsResponseBody
- type ScanNewResponseReportReportTestsStepsResponseBodyKind
- type ScanNewResponseReportReportTestsStepsResponseBodyUnion
- type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes
- type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind
- type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson
- type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind
- type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound
- type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind
- type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText
- type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind
- type ScanNewResponseReportReportTestsVerdict
- type ScanNewResponseScanType
- type ScanNewResponseStatus
- type ScanService
- func (r *ScanService) Get(ctx context.Context, scanID string, query ScanGetParams, ...) (res *ScanGetResponse, err error)
- func (r *ScanService) List(ctx context.Context, params ScanListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[ScanListResponse], err error)
- func (r *ScanService) ListAutoPaging(ctx context.Context, params ScanListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[ScanListResponse]
- func (r *ScanService) New(ctx context.Context, params ScanNewParams, opts ...option.RequestOption) (res *ScanNewResponse, err error)
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type TargetEnvironmentDeleteParams
- type TargetEnvironmentDeleteResponse
- type TargetEnvironmentDeleteResponseEnvelope
- type TargetEnvironmentDeleteResponseEnvelopeErrors
- type TargetEnvironmentDeleteResponseEnvelopeErrorsSource
- type TargetEnvironmentDeleteResponseEnvelopeMessages
- type TargetEnvironmentDeleteResponseEnvelopeMessagesSource
- type TargetEnvironmentDeleteResponseEnvelopeSuccess
- type TargetEnvironmentEditParams
- type TargetEnvironmentEditParamsTarget
- type TargetEnvironmentEditParamsTargetType
- type TargetEnvironmentEditResponse
- type TargetEnvironmentEditResponseEnvelope
- type TargetEnvironmentEditResponseEnvelopeErrors
- type TargetEnvironmentEditResponseEnvelopeErrorsSource
- type TargetEnvironmentEditResponseEnvelopeMessages
- type TargetEnvironmentEditResponseEnvelopeMessagesSource
- type TargetEnvironmentEditResponseEnvelopeSuccess
- type TargetEnvironmentEditResponseTarget
- type TargetEnvironmentEditResponseTargetType
- type TargetEnvironmentGetParams
- type TargetEnvironmentGetResponse
- type TargetEnvironmentGetResponseEnvelope
- type TargetEnvironmentGetResponseEnvelopeErrors
- type TargetEnvironmentGetResponseEnvelopeErrorsSource
- type TargetEnvironmentGetResponseEnvelopeMessages
- type TargetEnvironmentGetResponseEnvelopeMessagesSource
- type TargetEnvironmentGetResponseEnvelopeSuccess
- type TargetEnvironmentGetResponseTarget
- type TargetEnvironmentGetResponseTargetType
- type TargetEnvironmentListParams
- type TargetEnvironmentListResponse
- type TargetEnvironmentListResponseTarget
- type TargetEnvironmentListResponseTargetType
- type TargetEnvironmentNewParams
- type TargetEnvironmentNewParamsTarget
- type TargetEnvironmentNewParamsTargetType
- type TargetEnvironmentNewResponse
- type TargetEnvironmentNewResponseEnvelope
- type TargetEnvironmentNewResponseEnvelopeErrors
- type TargetEnvironmentNewResponseEnvelopeErrorsSource
- type TargetEnvironmentNewResponseEnvelopeMessages
- type TargetEnvironmentNewResponseEnvelopeMessagesSource
- type TargetEnvironmentNewResponseEnvelopeSuccess
- type TargetEnvironmentNewResponseTarget
- type TargetEnvironmentNewResponseTargetType
- type TargetEnvironmentService
- func (r *TargetEnvironmentService) Delete(ctx context.Context, targetEnvironmentID string, ...) (res *TargetEnvironmentDeleteResponse, err error)
- func (r *TargetEnvironmentService) Edit(ctx context.Context, targetEnvironmentID string, ...) (res *TargetEnvironmentEditResponse, err error)
- func (r *TargetEnvironmentService) Get(ctx context.Context, targetEnvironmentID string, ...) (res *TargetEnvironmentGetResponse, err error)
- func (r *TargetEnvironmentService) List(ctx context.Context, params TargetEnvironmentListParams, ...) (res *pagination.V4PagePaginationArray[TargetEnvironmentListResponse], ...)
- func (r *TargetEnvironmentService) ListAutoPaging(ctx context.Context, params TargetEnvironmentListParams, ...) *pagination.V4PagePaginationArrayAutoPager[TargetEnvironmentListResponse]
- func (r *TargetEnvironmentService) New(ctx context.Context, params TargetEnvironmentNewParams, ...) (res *TargetEnvironmentNewResponse, err error)
- func (r *TargetEnvironmentService) Update(ctx context.Context, targetEnvironmentID string, ...) (res *TargetEnvironmentUpdateResponse, err error)
- type TargetEnvironmentUpdateParams
- type TargetEnvironmentUpdateParamsTarget
- type TargetEnvironmentUpdateParamsTargetType
- type TargetEnvironmentUpdateResponse
- type TargetEnvironmentUpdateResponseEnvelope
- type TargetEnvironmentUpdateResponseEnvelopeErrors
- type TargetEnvironmentUpdateResponseEnvelopeErrorsSource
- type TargetEnvironmentUpdateResponseEnvelopeMessages
- type TargetEnvironmentUpdateResponseEnvelopeMessagesSource
- type TargetEnvironmentUpdateResponseEnvelopeSuccess
- type TargetEnvironmentUpdateResponseTarget
- type TargetEnvironmentUpdateResponseTargetType
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
- type VulnerabilityScannerService
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 CredentialSetCredentialDeleteResponse ¶
type CredentialSetCredentialDeleteResponse = interface{}
type CredentialSetCredentialDeleteResponseEnvelope ¶
type CredentialSetCredentialDeleteResponseEnvelope struct {
Errors []CredentialSetCredentialDeleteResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CredentialSetCredentialDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CredentialSetCredentialDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
Result CredentialSetCredentialDeleteResponse `json:"result" api:"nullable"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON credentialSetCredentialDeleteResponseEnvelopeJSON `json:"-"`
}
Standard response envelope with a `null` result. Operations that produce no result body return this response.
func (*CredentialSetCredentialDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *CredentialSetCredentialDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialDeleteResponseEnvelopeErrors ¶
type CredentialSetCredentialDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetCredentialDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON credentialSetCredentialDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CredentialSetCredentialDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CredentialSetCredentialDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialDeleteResponseEnvelopeErrorsSource ¶
type CredentialSetCredentialDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON credentialSetCredentialDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CredentialSetCredentialDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CredentialSetCredentialDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialDeleteResponseEnvelopeMessages ¶
type CredentialSetCredentialDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetCredentialDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON credentialSetCredentialDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CredentialSetCredentialDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CredentialSetCredentialDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialDeleteResponseEnvelopeMessagesSource ¶
type CredentialSetCredentialDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON credentialSetCredentialDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CredentialSetCredentialDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CredentialSetCredentialDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialDeleteResponseEnvelopeSuccess ¶
type CredentialSetCredentialDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CredentialSetCredentialDeleteResponseEnvelopeSuccessTrue CredentialSetCredentialDeleteResponseEnvelopeSuccess = true
)
func (CredentialSetCredentialDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r CredentialSetCredentialDeleteResponseEnvelopeSuccess) IsKnown() bool
type CredentialSetCredentialEditParams ¶
type CredentialSetCredentialEditParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Where the credential is attached in outgoing requests.
Location param.Field[CredentialSetCredentialEditParamsLocation] `json:"location"`
// Name of the header or cookie where the credential is attached.
LocationName param.Field[string] `json:"location_name"`
// Human-readable name.
Name param.Field[string] `json:"name"`
// The credential value. Write-only. Never returned in responses.
Value param.Field[string] `json:"value"`
}
func (CredentialSetCredentialEditParams) MarshalJSON ¶
func (r CredentialSetCredentialEditParams) MarshalJSON() (data []byte, err error)
type CredentialSetCredentialEditParamsLocation ¶
type CredentialSetCredentialEditParamsLocation string
Where the credential is attached in outgoing requests.
const ( CredentialSetCredentialEditParamsLocationHeader CredentialSetCredentialEditParamsLocation = "header" CredentialSetCredentialEditParamsLocationCookie CredentialSetCredentialEditParamsLocation = "cookie" )
func (CredentialSetCredentialEditParamsLocation) IsKnown ¶
func (r CredentialSetCredentialEditParamsLocation) IsKnown() bool
type CredentialSetCredentialEditResponse ¶
type CredentialSetCredentialEditResponse struct {
// Credential identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Parent credential set identifier.
CredentialSetID string `json:"credential_set_id" api:"required" format:"uuid"`
// Where the credential is attached in outgoing requests.
Location CredentialSetCredentialEditResponseLocation `json:"location" api:"required"`
// Name of the header or cookie where the credential is attached.
LocationName string `json:"location_name" api:"required"`
// Human-readable name.
Name string `json:"name" api:"required"`
JSON credentialSetCredentialEditResponseJSON `json:"-"`
}
A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses.
func (*CredentialSetCredentialEditResponse) UnmarshalJSON ¶
func (r *CredentialSetCredentialEditResponse) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialEditResponseEnvelope ¶
type CredentialSetCredentialEditResponseEnvelope struct {
Errors []CredentialSetCredentialEditResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CredentialSetCredentialEditResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CredentialSetCredentialEditResponseEnvelopeSuccess `json:"success" api:"required"`
// A credential attached to API requests during scanning. The credential `value` is
// write-only and never returned in responses.
Result CredentialSetCredentialEditResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON credentialSetCredentialEditResponseEnvelopeJSON `json:"-"`
}
func (*CredentialSetCredentialEditResponseEnvelope) UnmarshalJSON ¶
func (r *CredentialSetCredentialEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialEditResponseEnvelopeErrors ¶
type CredentialSetCredentialEditResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetCredentialEditResponseEnvelopeErrorsSource `json:"source"`
JSON credentialSetCredentialEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CredentialSetCredentialEditResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CredentialSetCredentialEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialEditResponseEnvelopeErrorsSource ¶
type CredentialSetCredentialEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON credentialSetCredentialEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CredentialSetCredentialEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CredentialSetCredentialEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialEditResponseEnvelopeMessages ¶
type CredentialSetCredentialEditResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetCredentialEditResponseEnvelopeMessagesSource `json:"source"`
JSON credentialSetCredentialEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CredentialSetCredentialEditResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CredentialSetCredentialEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialEditResponseEnvelopeMessagesSource ¶
type CredentialSetCredentialEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON credentialSetCredentialEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CredentialSetCredentialEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CredentialSetCredentialEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialEditResponseEnvelopeSuccess ¶
type CredentialSetCredentialEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CredentialSetCredentialEditResponseEnvelopeSuccessTrue CredentialSetCredentialEditResponseEnvelopeSuccess = true
)
func (CredentialSetCredentialEditResponseEnvelopeSuccess) IsKnown ¶
func (r CredentialSetCredentialEditResponseEnvelopeSuccess) IsKnown() bool
type CredentialSetCredentialEditResponseLocation ¶
type CredentialSetCredentialEditResponseLocation string
Where the credential is attached in outgoing requests.
const ( CredentialSetCredentialEditResponseLocationHeader CredentialSetCredentialEditResponseLocation = "header" CredentialSetCredentialEditResponseLocationCookie CredentialSetCredentialEditResponseLocation = "cookie" )
func (CredentialSetCredentialEditResponseLocation) IsKnown ¶
func (r CredentialSetCredentialEditResponseLocation) IsKnown() bool
type CredentialSetCredentialGetResponse ¶
type CredentialSetCredentialGetResponse struct {
// Credential identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Parent credential set identifier.
CredentialSetID string `json:"credential_set_id" api:"required" format:"uuid"`
// Where the credential is attached in outgoing requests.
Location CredentialSetCredentialGetResponseLocation `json:"location" api:"required"`
// Name of the header or cookie where the credential is attached.
LocationName string `json:"location_name" api:"required"`
// Human-readable name.
Name string `json:"name" api:"required"`
JSON credentialSetCredentialGetResponseJSON `json:"-"`
}
A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses.
func (*CredentialSetCredentialGetResponse) UnmarshalJSON ¶
func (r *CredentialSetCredentialGetResponse) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialGetResponseEnvelope ¶
type CredentialSetCredentialGetResponseEnvelope struct {
Errors []CredentialSetCredentialGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CredentialSetCredentialGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CredentialSetCredentialGetResponseEnvelopeSuccess `json:"success" api:"required"`
// A credential attached to API requests during scanning. The credential `value` is
// write-only and never returned in responses.
Result CredentialSetCredentialGetResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON credentialSetCredentialGetResponseEnvelopeJSON `json:"-"`
}
func (*CredentialSetCredentialGetResponseEnvelope) UnmarshalJSON ¶
func (r *CredentialSetCredentialGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialGetResponseEnvelopeErrors ¶
type CredentialSetCredentialGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetCredentialGetResponseEnvelopeErrorsSource `json:"source"`
JSON credentialSetCredentialGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CredentialSetCredentialGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CredentialSetCredentialGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialGetResponseEnvelopeErrorsSource ¶
type CredentialSetCredentialGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON credentialSetCredentialGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CredentialSetCredentialGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CredentialSetCredentialGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialGetResponseEnvelopeMessages ¶
type CredentialSetCredentialGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetCredentialGetResponseEnvelopeMessagesSource `json:"source"`
JSON credentialSetCredentialGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CredentialSetCredentialGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CredentialSetCredentialGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialGetResponseEnvelopeMessagesSource ¶
type CredentialSetCredentialGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON credentialSetCredentialGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CredentialSetCredentialGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CredentialSetCredentialGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialGetResponseEnvelopeSuccess ¶
type CredentialSetCredentialGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CredentialSetCredentialGetResponseEnvelopeSuccessTrue CredentialSetCredentialGetResponseEnvelopeSuccess = true
)
func (CredentialSetCredentialGetResponseEnvelopeSuccess) IsKnown ¶
func (r CredentialSetCredentialGetResponseEnvelopeSuccess) IsKnown() bool
type CredentialSetCredentialGetResponseLocation ¶
type CredentialSetCredentialGetResponseLocation string
Where the credential is attached in outgoing requests.
const ( CredentialSetCredentialGetResponseLocationHeader CredentialSetCredentialGetResponseLocation = "header" CredentialSetCredentialGetResponseLocationCookie CredentialSetCredentialGetResponseLocation = "cookie" )
func (CredentialSetCredentialGetResponseLocation) IsKnown ¶
func (r CredentialSetCredentialGetResponseLocation) IsKnown() bool
type CredentialSetCredentialListParams ¶
type CredentialSetCredentialListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Page number of paginated results.
Page param.Field[int64] `query:"page"`
// Number of results per page.
PerPage param.Field[int64] `query:"per_page"`
}
func (CredentialSetCredentialListParams) URLQuery ¶
func (r CredentialSetCredentialListParams) URLQuery() (v url.Values)
URLQuery serializes CredentialSetCredentialListParams's query parameters as `url.Values`.
type CredentialSetCredentialListResponse ¶
type CredentialSetCredentialListResponse struct {
// Credential identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Parent credential set identifier.
CredentialSetID string `json:"credential_set_id" api:"required" format:"uuid"`
// Where the credential is attached in outgoing requests.
Location CredentialSetCredentialListResponseLocation `json:"location" api:"required"`
// Name of the header or cookie where the credential is attached.
LocationName string `json:"location_name" api:"required"`
// Human-readable name.
Name string `json:"name" api:"required"`
JSON credentialSetCredentialListResponseJSON `json:"-"`
}
A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses.
func (*CredentialSetCredentialListResponse) UnmarshalJSON ¶
func (r *CredentialSetCredentialListResponse) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialListResponseLocation ¶
type CredentialSetCredentialListResponseLocation string
Where the credential is attached in outgoing requests.
const ( CredentialSetCredentialListResponseLocationHeader CredentialSetCredentialListResponseLocation = "header" CredentialSetCredentialListResponseLocationCookie CredentialSetCredentialListResponseLocation = "cookie" )
func (CredentialSetCredentialListResponseLocation) IsKnown ¶
func (r CredentialSetCredentialListResponseLocation) IsKnown() bool
type CredentialSetCredentialNewParams ¶
type CredentialSetCredentialNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Where the credential is attached in outgoing requests.
Location param.Field[CredentialSetCredentialNewParamsLocation] `json:"location" api:"required"`
// Name of the header or cookie where the credential is attached.
LocationName param.Field[string] `json:"location_name" api:"required"`
// Human-readable name.
Name param.Field[string] `json:"name" api:"required"`
// The credential value (e.g. API key, session token). Write-only. Never returned
// in responses.
Value param.Field[string] `json:"value" api:"required"`
}
func (CredentialSetCredentialNewParams) MarshalJSON ¶
func (r CredentialSetCredentialNewParams) MarshalJSON() (data []byte, err error)
type CredentialSetCredentialNewParamsLocation ¶
type CredentialSetCredentialNewParamsLocation string
Where the credential is attached in outgoing requests.
const ( CredentialSetCredentialNewParamsLocationHeader CredentialSetCredentialNewParamsLocation = "header" CredentialSetCredentialNewParamsLocationCookie CredentialSetCredentialNewParamsLocation = "cookie" )
func (CredentialSetCredentialNewParamsLocation) IsKnown ¶
func (r CredentialSetCredentialNewParamsLocation) IsKnown() bool
type CredentialSetCredentialNewResponse ¶
type CredentialSetCredentialNewResponse struct {
// Credential identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Parent credential set identifier.
CredentialSetID string `json:"credential_set_id" api:"required" format:"uuid"`
// Where the credential is attached in outgoing requests.
Location CredentialSetCredentialNewResponseLocation `json:"location" api:"required"`
// Name of the header or cookie where the credential is attached.
LocationName string `json:"location_name" api:"required"`
// Human-readable name.
Name string `json:"name" api:"required"`
JSON credentialSetCredentialNewResponseJSON `json:"-"`
}
A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses.
func (*CredentialSetCredentialNewResponse) UnmarshalJSON ¶
func (r *CredentialSetCredentialNewResponse) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialNewResponseEnvelope ¶
type CredentialSetCredentialNewResponseEnvelope struct {
Errors []CredentialSetCredentialNewResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CredentialSetCredentialNewResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CredentialSetCredentialNewResponseEnvelopeSuccess `json:"success" api:"required"`
// A credential attached to API requests during scanning. The credential `value` is
// write-only and never returned in responses.
Result CredentialSetCredentialNewResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON credentialSetCredentialNewResponseEnvelopeJSON `json:"-"`
}
func (*CredentialSetCredentialNewResponseEnvelope) UnmarshalJSON ¶
func (r *CredentialSetCredentialNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialNewResponseEnvelopeErrors ¶
type CredentialSetCredentialNewResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetCredentialNewResponseEnvelopeErrorsSource `json:"source"`
JSON credentialSetCredentialNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CredentialSetCredentialNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CredentialSetCredentialNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialNewResponseEnvelopeErrorsSource ¶
type CredentialSetCredentialNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON credentialSetCredentialNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CredentialSetCredentialNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CredentialSetCredentialNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialNewResponseEnvelopeMessages ¶
type CredentialSetCredentialNewResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetCredentialNewResponseEnvelopeMessagesSource `json:"source"`
JSON credentialSetCredentialNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CredentialSetCredentialNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CredentialSetCredentialNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialNewResponseEnvelopeMessagesSource ¶
type CredentialSetCredentialNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON credentialSetCredentialNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CredentialSetCredentialNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CredentialSetCredentialNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialNewResponseEnvelopeSuccess ¶
type CredentialSetCredentialNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CredentialSetCredentialNewResponseEnvelopeSuccessTrue CredentialSetCredentialNewResponseEnvelopeSuccess = true
)
func (CredentialSetCredentialNewResponseEnvelopeSuccess) IsKnown ¶
func (r CredentialSetCredentialNewResponseEnvelopeSuccess) IsKnown() bool
type CredentialSetCredentialNewResponseLocation ¶
type CredentialSetCredentialNewResponseLocation string
Where the credential is attached in outgoing requests.
const ( CredentialSetCredentialNewResponseLocationHeader CredentialSetCredentialNewResponseLocation = "header" CredentialSetCredentialNewResponseLocationCookie CredentialSetCredentialNewResponseLocation = "cookie" )
func (CredentialSetCredentialNewResponseLocation) IsKnown ¶
func (r CredentialSetCredentialNewResponseLocation) IsKnown() bool
type CredentialSetCredentialService ¶
type CredentialSetCredentialService struct {
Options []option.RequestOption
}
CredentialSetCredentialService 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 NewCredentialSetCredentialService method instead.
func NewCredentialSetCredentialService ¶
func NewCredentialSetCredentialService(opts ...option.RequestOption) (r *CredentialSetCredentialService)
NewCredentialSetCredentialService 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 (*CredentialSetCredentialService) Delete ¶
func (r *CredentialSetCredentialService) Delete(ctx context.Context, credentialSetID string, credentialID string, body CredentialSetCredentialDeleteParams, opts ...option.RequestOption) (res *CredentialSetCredentialDeleteResponse, err error)
Deletes a credential.
func (*CredentialSetCredentialService) Edit ¶
func (r *CredentialSetCredentialService) Edit(ctx context.Context, credentialSetID string, credentialID string, params CredentialSetCredentialEditParams, opts ...option.RequestOption) (res *CredentialSetCredentialEditResponse, err error)
Updates a credential with only the provided fields; omitted fields remain unchanged.
func (*CredentialSetCredentialService) Get ¶
func (r *CredentialSetCredentialService) Get(ctx context.Context, credentialSetID string, credentialID string, query CredentialSetCredentialGetParams, opts ...option.RequestOption) (res *CredentialSetCredentialGetResponse, err error)
Returns a single credential by ID.
func (*CredentialSetCredentialService) List ¶
func (r *CredentialSetCredentialService) List(ctx context.Context, credentialSetID string, params CredentialSetCredentialListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[CredentialSetCredentialListResponse], err error)
Returns all credentials within a credential set.
func (*CredentialSetCredentialService) ListAutoPaging ¶
func (r *CredentialSetCredentialService) ListAutoPaging(ctx context.Context, credentialSetID string, params CredentialSetCredentialListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[CredentialSetCredentialListResponse]
Returns all credentials within a credential set.
func (*CredentialSetCredentialService) New ¶
func (r *CredentialSetCredentialService) New(ctx context.Context, credentialSetID string, params CredentialSetCredentialNewParams, opts ...option.RequestOption) (res *CredentialSetCredentialNewResponse, err error)
Creates a new credential within a credential set.
func (*CredentialSetCredentialService) Update ¶
func (r *CredentialSetCredentialService) Update(ctx context.Context, credentialSetID string, credentialID string, params CredentialSetCredentialUpdateParams, opts ...option.RequestOption) (res *CredentialSetCredentialUpdateResponse, err error)
Replaces a credential. All fields must be provided.
type CredentialSetCredentialUpdateParams ¶
type CredentialSetCredentialUpdateParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Where the credential is attached in outgoing requests.
Location param.Field[CredentialSetCredentialUpdateParamsLocation] `json:"location" api:"required"`
// Name of the header or cookie where the credential is attached.
LocationName param.Field[string] `json:"location_name" api:"required"`
// Human-readable name.
Name param.Field[string] `json:"name" api:"required"`
// The credential value. Write-only. Never returned in responses.
Value param.Field[string] `json:"value" api:"required"`
}
func (CredentialSetCredentialUpdateParams) MarshalJSON ¶
func (r CredentialSetCredentialUpdateParams) MarshalJSON() (data []byte, err error)
type CredentialSetCredentialUpdateParamsLocation ¶
type CredentialSetCredentialUpdateParamsLocation string
Where the credential is attached in outgoing requests.
const ( CredentialSetCredentialUpdateParamsLocationHeader CredentialSetCredentialUpdateParamsLocation = "header" CredentialSetCredentialUpdateParamsLocationCookie CredentialSetCredentialUpdateParamsLocation = "cookie" )
func (CredentialSetCredentialUpdateParamsLocation) IsKnown ¶
func (r CredentialSetCredentialUpdateParamsLocation) IsKnown() bool
type CredentialSetCredentialUpdateResponse ¶
type CredentialSetCredentialUpdateResponse struct {
// Credential identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Parent credential set identifier.
CredentialSetID string `json:"credential_set_id" api:"required" format:"uuid"`
// Where the credential is attached in outgoing requests.
Location CredentialSetCredentialUpdateResponseLocation `json:"location" api:"required"`
// Name of the header or cookie where the credential is attached.
LocationName string `json:"location_name" api:"required"`
// Human-readable name.
Name string `json:"name" api:"required"`
JSON credentialSetCredentialUpdateResponseJSON `json:"-"`
}
A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses.
func (*CredentialSetCredentialUpdateResponse) UnmarshalJSON ¶
func (r *CredentialSetCredentialUpdateResponse) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialUpdateResponseEnvelope ¶
type CredentialSetCredentialUpdateResponseEnvelope struct {
Errors []CredentialSetCredentialUpdateResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CredentialSetCredentialUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CredentialSetCredentialUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
// A credential attached to API requests during scanning. The credential `value` is
// write-only and never returned in responses.
Result CredentialSetCredentialUpdateResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON credentialSetCredentialUpdateResponseEnvelopeJSON `json:"-"`
}
func (*CredentialSetCredentialUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *CredentialSetCredentialUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialUpdateResponseEnvelopeErrors ¶
type CredentialSetCredentialUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetCredentialUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON credentialSetCredentialUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CredentialSetCredentialUpdateResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CredentialSetCredentialUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialUpdateResponseEnvelopeErrorsSource ¶
type CredentialSetCredentialUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON credentialSetCredentialUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CredentialSetCredentialUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CredentialSetCredentialUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialUpdateResponseEnvelopeMessages ¶
type CredentialSetCredentialUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetCredentialUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON credentialSetCredentialUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CredentialSetCredentialUpdateResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CredentialSetCredentialUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialUpdateResponseEnvelopeMessagesSource ¶
type CredentialSetCredentialUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON credentialSetCredentialUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CredentialSetCredentialUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CredentialSetCredentialUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetCredentialUpdateResponseEnvelopeSuccess ¶
type CredentialSetCredentialUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CredentialSetCredentialUpdateResponseEnvelopeSuccessTrue CredentialSetCredentialUpdateResponseEnvelopeSuccess = true
)
func (CredentialSetCredentialUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r CredentialSetCredentialUpdateResponseEnvelopeSuccess) IsKnown() bool
type CredentialSetCredentialUpdateResponseLocation ¶
type CredentialSetCredentialUpdateResponseLocation string
Where the credential is attached in outgoing requests.
const ( CredentialSetCredentialUpdateResponseLocationHeader CredentialSetCredentialUpdateResponseLocation = "header" CredentialSetCredentialUpdateResponseLocationCookie CredentialSetCredentialUpdateResponseLocation = "cookie" )
func (CredentialSetCredentialUpdateResponseLocation) IsKnown ¶
func (r CredentialSetCredentialUpdateResponseLocation) IsKnown() bool
type CredentialSetDeleteResponse ¶
type CredentialSetDeleteResponse = interface{}
type CredentialSetDeleteResponseEnvelope ¶
type CredentialSetDeleteResponseEnvelope struct {
Errors []CredentialSetDeleteResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CredentialSetDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CredentialSetDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
Result CredentialSetDeleteResponse `json:"result" api:"nullable"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON credentialSetDeleteResponseEnvelopeJSON `json:"-"`
}
Standard response envelope with a `null` result. Operations that produce no result body return this response.
func (*CredentialSetDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *CredentialSetDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CredentialSetDeleteResponseEnvelopeErrors ¶
type CredentialSetDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON credentialSetDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CredentialSetDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CredentialSetDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CredentialSetDeleteResponseEnvelopeErrorsSource ¶
type CredentialSetDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON credentialSetDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CredentialSetDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CredentialSetDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetDeleteResponseEnvelopeMessages ¶
type CredentialSetDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON credentialSetDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CredentialSetDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CredentialSetDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CredentialSetDeleteResponseEnvelopeMessagesSource ¶
type CredentialSetDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON credentialSetDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CredentialSetDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CredentialSetDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetDeleteResponseEnvelopeSuccess ¶
type CredentialSetDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CredentialSetDeleteResponseEnvelopeSuccessTrue CredentialSetDeleteResponseEnvelopeSuccess = true
)
func (CredentialSetDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r CredentialSetDeleteResponseEnvelopeSuccess) IsKnown() bool
type CredentialSetEditParams ¶
type CredentialSetEditParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Human-readable name.
Name param.Field[string] `json:"name"`
}
func (CredentialSetEditParams) MarshalJSON ¶
func (r CredentialSetEditParams) MarshalJSON() (data []byte, err error)
type CredentialSetEditResponse ¶
type CredentialSetEditResponse struct {
// Credential set identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Human-readable name.
Name string `json:"name" api:"required"`
JSON credentialSetEditResponseJSON `json:"-"`
}
func (*CredentialSetEditResponse) UnmarshalJSON ¶
func (r *CredentialSetEditResponse) UnmarshalJSON(data []byte) (err error)
type CredentialSetEditResponseEnvelope ¶
type CredentialSetEditResponseEnvelope struct {
Errors []CredentialSetEditResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CredentialSetEditResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CredentialSetEditResponseEnvelopeSuccess `json:"success" api:"required"`
Result CredentialSetEditResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON credentialSetEditResponseEnvelopeJSON `json:"-"`
}
func (*CredentialSetEditResponseEnvelope) UnmarshalJSON ¶
func (r *CredentialSetEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CredentialSetEditResponseEnvelopeErrors ¶
type CredentialSetEditResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetEditResponseEnvelopeErrorsSource `json:"source"`
JSON credentialSetEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CredentialSetEditResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CredentialSetEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CredentialSetEditResponseEnvelopeErrorsSource ¶
type CredentialSetEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON credentialSetEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CredentialSetEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CredentialSetEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetEditResponseEnvelopeMessages ¶
type CredentialSetEditResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetEditResponseEnvelopeMessagesSource `json:"source"`
JSON credentialSetEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CredentialSetEditResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CredentialSetEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CredentialSetEditResponseEnvelopeMessagesSource ¶
type CredentialSetEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON credentialSetEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CredentialSetEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CredentialSetEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetEditResponseEnvelopeSuccess ¶
type CredentialSetEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CredentialSetEditResponseEnvelopeSuccessTrue CredentialSetEditResponseEnvelopeSuccess = true
)
func (CredentialSetEditResponseEnvelopeSuccess) IsKnown ¶
func (r CredentialSetEditResponseEnvelopeSuccess) IsKnown() bool
type CredentialSetGetParams ¶
type CredentialSetGetResponse ¶
type CredentialSetGetResponse struct {
// Credential set identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Human-readable name.
Name string `json:"name" api:"required"`
JSON credentialSetGetResponseJSON `json:"-"`
}
func (*CredentialSetGetResponse) UnmarshalJSON ¶
func (r *CredentialSetGetResponse) UnmarshalJSON(data []byte) (err error)
type CredentialSetGetResponseEnvelope ¶
type CredentialSetGetResponseEnvelope struct {
Errors []CredentialSetGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CredentialSetGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CredentialSetGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result CredentialSetGetResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON credentialSetGetResponseEnvelopeJSON `json:"-"`
}
func (*CredentialSetGetResponseEnvelope) UnmarshalJSON ¶
func (r *CredentialSetGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CredentialSetGetResponseEnvelopeErrors ¶
type CredentialSetGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetGetResponseEnvelopeErrorsSource `json:"source"`
JSON credentialSetGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CredentialSetGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CredentialSetGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CredentialSetGetResponseEnvelopeErrorsSource ¶
type CredentialSetGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON credentialSetGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CredentialSetGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CredentialSetGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetGetResponseEnvelopeMessages ¶
type CredentialSetGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetGetResponseEnvelopeMessagesSource `json:"source"`
JSON credentialSetGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CredentialSetGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CredentialSetGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CredentialSetGetResponseEnvelopeMessagesSource ¶
type CredentialSetGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON credentialSetGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CredentialSetGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CredentialSetGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetGetResponseEnvelopeSuccess ¶
type CredentialSetGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CredentialSetGetResponseEnvelopeSuccessTrue CredentialSetGetResponseEnvelopeSuccess = true
)
func (CredentialSetGetResponseEnvelopeSuccess) IsKnown ¶
func (r CredentialSetGetResponseEnvelopeSuccess) IsKnown() bool
type CredentialSetListParams ¶
type CredentialSetListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Page number of paginated results.
Page param.Field[int64] `query:"page"`
// Number of results per page.
PerPage param.Field[int64] `query:"per_page"`
}
func (CredentialSetListParams) URLQuery ¶
func (r CredentialSetListParams) URLQuery() (v url.Values)
URLQuery serializes CredentialSetListParams's query parameters as `url.Values`.
type CredentialSetListResponse ¶
type CredentialSetListResponse struct {
// Credential set identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Human-readable name.
Name string `json:"name" api:"required"`
JSON credentialSetListResponseJSON `json:"-"`
}
func (*CredentialSetListResponse) UnmarshalJSON ¶
func (r *CredentialSetListResponse) UnmarshalJSON(data []byte) (err error)
type CredentialSetNewParams ¶
type CredentialSetNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Human-readable name.
Name param.Field[string] `json:"name" api:"required"`
}
func (CredentialSetNewParams) MarshalJSON ¶
func (r CredentialSetNewParams) MarshalJSON() (data []byte, err error)
type CredentialSetNewResponse ¶
type CredentialSetNewResponse struct {
// Credential set identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Human-readable name.
Name string `json:"name" api:"required"`
JSON credentialSetNewResponseJSON `json:"-"`
}
func (*CredentialSetNewResponse) UnmarshalJSON ¶
func (r *CredentialSetNewResponse) UnmarshalJSON(data []byte) (err error)
type CredentialSetNewResponseEnvelope ¶
type CredentialSetNewResponseEnvelope struct {
Errors []CredentialSetNewResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CredentialSetNewResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CredentialSetNewResponseEnvelopeSuccess `json:"success" api:"required"`
Result CredentialSetNewResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON credentialSetNewResponseEnvelopeJSON `json:"-"`
}
func (*CredentialSetNewResponseEnvelope) UnmarshalJSON ¶
func (r *CredentialSetNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CredentialSetNewResponseEnvelopeErrors ¶
type CredentialSetNewResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetNewResponseEnvelopeErrorsSource `json:"source"`
JSON credentialSetNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CredentialSetNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CredentialSetNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CredentialSetNewResponseEnvelopeErrorsSource ¶
type CredentialSetNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON credentialSetNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CredentialSetNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CredentialSetNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetNewResponseEnvelopeMessages ¶
type CredentialSetNewResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetNewResponseEnvelopeMessagesSource `json:"source"`
JSON credentialSetNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CredentialSetNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CredentialSetNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CredentialSetNewResponseEnvelopeMessagesSource ¶
type CredentialSetNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON credentialSetNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CredentialSetNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CredentialSetNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetNewResponseEnvelopeSuccess ¶
type CredentialSetNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CredentialSetNewResponseEnvelopeSuccessTrue CredentialSetNewResponseEnvelopeSuccess = true
)
func (CredentialSetNewResponseEnvelopeSuccess) IsKnown ¶
func (r CredentialSetNewResponseEnvelopeSuccess) IsKnown() bool
type CredentialSetService ¶
type CredentialSetService struct {
Options []option.RequestOption
Credentials *CredentialSetCredentialService
}
CredentialSetService 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 NewCredentialSetService method instead.
func NewCredentialSetService ¶
func NewCredentialSetService(opts ...option.RequestOption) (r *CredentialSetService)
NewCredentialSetService 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 (*CredentialSetService) Delete ¶
func (r *CredentialSetService) Delete(ctx context.Context, credentialSetID string, body CredentialSetDeleteParams, opts ...option.RequestOption) (res *CredentialSetDeleteResponse, err error)
Deletes a credential set and all of its credentials.
func (*CredentialSetService) Edit ¶
func (r *CredentialSetService) Edit(ctx context.Context, credentialSetID string, params CredentialSetEditParams, opts ...option.RequestOption) (res *CredentialSetEditResponse, err error)
Updates a credential set with only the provided fields; omitted fields remain unchanged.
func (*CredentialSetService) Get ¶
func (r *CredentialSetService) Get(ctx context.Context, credentialSetID string, query CredentialSetGetParams, opts ...option.RequestOption) (res *CredentialSetGetResponse, err error)
Returns a single credential set by ID.
func (*CredentialSetService) List ¶
func (r *CredentialSetService) List(ctx context.Context, params CredentialSetListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[CredentialSetListResponse], err error)
Returns all credential sets for the account.
func (*CredentialSetService) ListAutoPaging ¶
func (r *CredentialSetService) ListAutoPaging(ctx context.Context, params CredentialSetListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[CredentialSetListResponse]
Returns all credential sets for the account.
func (*CredentialSetService) New ¶
func (r *CredentialSetService) New(ctx context.Context, params CredentialSetNewParams, opts ...option.RequestOption) (res *CredentialSetNewResponse, err error)
Creates a new credential set.
func (*CredentialSetService) Update ¶
func (r *CredentialSetService) Update(ctx context.Context, credentialSetID string, params CredentialSetUpdateParams, opts ...option.RequestOption) (res *CredentialSetUpdateResponse, err error)
Replaces a credential set. All fields must be provided.
type CredentialSetUpdateParams ¶
type CredentialSetUpdateParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Human-readable name.
Name param.Field[string] `json:"name" api:"required"`
}
func (CredentialSetUpdateParams) MarshalJSON ¶
func (r CredentialSetUpdateParams) MarshalJSON() (data []byte, err error)
type CredentialSetUpdateResponse ¶
type CredentialSetUpdateResponse struct {
// Credential set identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Human-readable name.
Name string `json:"name" api:"required"`
JSON credentialSetUpdateResponseJSON `json:"-"`
}
func (*CredentialSetUpdateResponse) UnmarshalJSON ¶
func (r *CredentialSetUpdateResponse) UnmarshalJSON(data []byte) (err error)
type CredentialSetUpdateResponseEnvelope ¶
type CredentialSetUpdateResponseEnvelope struct {
Errors []CredentialSetUpdateResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CredentialSetUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CredentialSetUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
Result CredentialSetUpdateResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON credentialSetUpdateResponseEnvelopeJSON `json:"-"`
}
func (*CredentialSetUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *CredentialSetUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CredentialSetUpdateResponseEnvelopeErrors ¶
type CredentialSetUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON credentialSetUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CredentialSetUpdateResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CredentialSetUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CredentialSetUpdateResponseEnvelopeErrorsSource ¶
type CredentialSetUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON credentialSetUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CredentialSetUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CredentialSetUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetUpdateResponseEnvelopeMessages ¶
type CredentialSetUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CredentialSetUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON credentialSetUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CredentialSetUpdateResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CredentialSetUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CredentialSetUpdateResponseEnvelopeMessagesSource ¶
type CredentialSetUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON credentialSetUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CredentialSetUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CredentialSetUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CredentialSetUpdateResponseEnvelopeSuccess ¶
type CredentialSetUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CredentialSetUpdateResponseEnvelopeSuccessTrue CredentialSetUpdateResponseEnvelopeSuccess = true
)
func (CredentialSetUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r CredentialSetUpdateResponseEnvelopeSuccess) IsKnown() bool
type ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
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 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 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 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 ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
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 ScanGetParams ¶
type ScanGetResponse ¶
type ScanGetResponse struct {
// Scan identifier.
ID string `json:"id" api:"required" format:"uuid"`
// The type of vulnerability scan.
ScanType ScanGetResponseScanType `json:"scan_type" api:"required"`
// Current lifecycle status of the scan.
Status ScanGetResponseStatus `json:"status" api:"required"`
// The target environment this scan runs against.
TargetEnvironmentID string `json:"target_environment_id" api:"required" format:"uuid"`
// Vulnerability report produced after the scan completes. The shape depends on the
// scan type. Present only for finished scans.
Report ScanGetResponseReport `json:"report" api:"nullable"`
JSON scanGetResponseJSON `json:"-"`
}
func (*ScanGetResponse) UnmarshalJSON ¶
func (r *ScanGetResponse) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseEnvelope ¶
type ScanGetResponseEnvelope struct {
Errors []ScanGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ScanGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success ScanGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result ScanGetResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON scanGetResponseEnvelopeJSON `json:"-"`
}
func (*ScanGetResponseEnvelope) UnmarshalJSON ¶
func (r *ScanGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseEnvelopeErrors ¶
type ScanGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ScanGetResponseEnvelopeErrorsSource `json:"source"`
JSON scanGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ScanGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ScanGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseEnvelopeErrorsSource ¶
type ScanGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON scanGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ScanGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ScanGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseEnvelopeMessages ¶
type ScanGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ScanGetResponseEnvelopeMessagesSource `json:"source"`
JSON scanGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ScanGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ScanGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseEnvelopeMessagesSource ¶
type ScanGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON scanGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ScanGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *ScanGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseEnvelopeSuccess ¶
type ScanGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ScanGetResponseEnvelopeSuccessTrue ScanGetResponseEnvelopeSuccess = true
)
func (ScanGetResponseEnvelopeSuccess) IsKnown ¶
func (r ScanGetResponseEnvelopeSuccess) IsKnown() bool
type ScanGetResponseReport ¶
type ScanGetResponseReport struct {
// Version 1 of the BOLA vulnerability scan report.
Report ScanGetResponseReportReport `json:"report" api:"required"`
// Version of the report schema.
ReportSchemaVersion ScanGetResponseReportReportSchemaVersion `json:"report_schema_version" api:"required"`
JSON scanGetResponseReportJSON `json:"-"`
}
Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans.
func (*ScanGetResponseReport) UnmarshalJSON ¶
func (r *ScanGetResponseReport) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReport ¶
type ScanGetResponseReportReport struct {
// Summary of all steps and findings.
Summary ScanGetResponseReportReportSummary `json:"summary" api:"required"`
// List of tests that were run.
Tests []ScanGetResponseReportReportTest `json:"tests" api:"required"`
JSON scanGetResponseReportReportJSON `json:"-"`
}
Version 1 of the BOLA vulnerability scan report.
func (*ScanGetResponseReportReport) UnmarshalJSON ¶
func (r *ScanGetResponseReportReport) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportSchemaVersion ¶
type ScanGetResponseReportReportSchemaVersion string
Version of the report schema.
const (
ScanGetResponseReportReportSchemaVersionV1 ScanGetResponseReportReportSchemaVersion = "v1"
)
func (ScanGetResponseReportReportSchemaVersion) IsKnown ¶
func (r ScanGetResponseReportReportSchemaVersion) IsKnown() bool
type ScanGetResponseReportReportSummary ¶
type ScanGetResponseReportReportSummary struct {
// Overall verdict of the vulnerability scan.
Verdict ScanGetResponseReportReportSummaryVerdict `json:"verdict" api:"required"`
JSON scanGetResponseReportReportSummaryJSON `json:"-"`
}
Summary of all steps and findings.
func (*ScanGetResponseReportReportSummary) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportSummary) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportSummaryVerdict ¶
type ScanGetResponseReportReportSummaryVerdict string
Overall verdict of the vulnerability scan.
const ( ScanGetResponseReportReportSummaryVerdictOk ScanGetResponseReportReportSummaryVerdict = "ok" ScanGetResponseReportReportSummaryVerdictWarning ScanGetResponseReportReportSummaryVerdict = "warning" ScanGetResponseReportReportSummaryVerdictInconclusive ScanGetResponseReportReportSummaryVerdict = "inconclusive" )
func (ScanGetResponseReportReportSummaryVerdict) IsKnown ¶
func (r ScanGetResponseReportReportSummaryVerdict) IsKnown() bool
type ScanGetResponseReportReportTest ¶
type ScanGetResponseReportReportTest struct {
// Steps that were executed.
Steps []ScanGetResponseReportReportTestsStep `json:"steps" api:"required"`
// Verdict of this single test.
Verdict ScanGetResponseReportReportTestsVerdict `json:"verdict" api:"required"`
// Errors that prevented step execution.
PreflightErrors []ScanGetResponseReportReportTestsPreflightError `json:"preflight_errors"`
JSON scanGetResponseReportReportTestJSON `json:"-"`
}
Result of a single test.
func (*ScanGetResponseReportReportTest) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTest) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsPreflightError ¶
type ScanGetResponseReportReportTestsPreflightError struct {
// Human-readable error description.
Description string `json:"description" api:"required"`
// Numeric error code identifying the class of error, if available.
ErrorCode int64 `json:"error_code" api:"nullable"`
JSON scanGetResponseReportReportTestsPreflightErrorJSON `json:"-"`
}
Error that occurred during a test.
func (*ScanGetResponseReportReportTestsPreflightError) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsPreflightError) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStep ¶
type ScanGetResponseReportReportTestsStep struct {
// Assertions that were made against the received response.
Assertions []ScanGetResponseReportReportTestsStepsAssertion `json:"assertions" api:"required"`
// Errors the step encountered that may explain absent or incomplete fields.
Errors []ScanGetResponseReportReportTestsStepsError `json:"errors"`
// HTTP request that was made, if any.
Request ScanGetResponseReportReportTestsStepsRequest `json:"request" api:"nullable"`
// HTTP response that was received, if any.
Response ScanGetResponseReportReportTestsStepsResponse `json:"response" api:"nullable"`
JSON scanGetResponseReportReportTestsStepJSON `json:"-"`
}
A single step in a test.
func (*ScanGetResponseReportReportTestsStep) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStep) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsAssertion ¶
type ScanGetResponseReportReportTestsStepsAssertion struct {
// Human-readable description of the assertion, explaining what was checked.
Description string `json:"description" api:"required"`
// Kind of assertion.
Kind ScanGetResponseReportReportTestsStepsAssertionsKind `json:"kind" api:"required"`
// Observed value on which the assertion was made.
Observed int64 `json:"observed" api:"required,nullable"`
// Outcome of the assertion.
Outcome ScanGetResponseReportReportTestsStepsAssertionsOutcome `json:"outcome" api:"required"`
JSON scanGetResponseReportReportTestsStepsAssertionJSON `json:"-"`
}
Assertion that was made against the received response.
func (*ScanGetResponseReportReportTestsStepsAssertion) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsAssertion) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsAssertionsKind ¶
type ScanGetResponseReportReportTestsStepsAssertionsKind struct {
// Range of HTTP status codes.
Parameters ScanGetResponseReportReportTestsStepsAssertionsKindParameters `json:"parameters" api:"required"`
Type ScanGetResponseReportReportTestsStepsAssertionsKindType `json:"type" api:"required"`
JSON scanGetResponseReportReportTestsStepsAssertionsKindJSON `json:"-"`
}
Kind of assertion.
func (*ScanGetResponseReportReportTestsStepsAssertionsKind) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsAssertionsKind) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsAssertionsKindParameters ¶
type ScanGetResponseReportReportTestsStepsAssertionsKindParameters struct {
// Maximum (inclusive) status code of the range.
Max int64 `json:"max" api:"required"`
// Minimum (inclusive) status code of the range.
Min int64 `json:"min" api:"required"`
JSON scanGetResponseReportReportTestsStepsAssertionsKindParametersJSON `json:"-"`
}
Range of HTTP status codes.
func (*ScanGetResponseReportReportTestsStepsAssertionsKindParameters) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsAssertionsKindParameters) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsAssertionsKindType ¶
type ScanGetResponseReportReportTestsStepsAssertionsKindType string
const (
ScanGetResponseReportReportTestsStepsAssertionsKindTypeHTTPStatusWithinRange ScanGetResponseReportReportTestsStepsAssertionsKindType = "http_status_within_range"
)
func (ScanGetResponseReportReportTestsStepsAssertionsKindType) IsKnown ¶
func (r ScanGetResponseReportReportTestsStepsAssertionsKindType) IsKnown() bool
type ScanGetResponseReportReportTestsStepsAssertionsOutcome ¶
type ScanGetResponseReportReportTestsStepsAssertionsOutcome string
Outcome of the assertion.
const ( ScanGetResponseReportReportTestsStepsAssertionsOutcomeOk ScanGetResponseReportReportTestsStepsAssertionsOutcome = "ok" ScanGetResponseReportReportTestsStepsAssertionsOutcomeFail ScanGetResponseReportReportTestsStepsAssertionsOutcome = "fail" ScanGetResponseReportReportTestsStepsAssertionsOutcomeInconclusive ScanGetResponseReportReportTestsStepsAssertionsOutcome = "inconclusive" )
func (ScanGetResponseReportReportTestsStepsAssertionsOutcome) IsKnown ¶
func (r ScanGetResponseReportReportTestsStepsAssertionsOutcome) IsKnown() bool
type ScanGetResponseReportReportTestsStepsError ¶
type ScanGetResponseReportReportTestsStepsError struct {
// Human-readable error description.
Description string `json:"description" api:"required"`
// Numeric error code identifying the class of error, if available.
ErrorCode int64 `json:"error_code" api:"nullable"`
JSON scanGetResponseReportReportTestsStepsErrorJSON `json:"-"`
}
Error that occurred during a test.
func (*ScanGetResponseReportReportTestsStepsError) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsError) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsRequest ¶
type ScanGetResponseReportReportTestsStepsRequest struct {
// Credential set that was used.
CredentialSet ScanGetResponseReportReportTestsStepsRequestCredentialSet `json:"credential_set" api:"required"`
// Names of headers that were sent.
HeaderNames []string `json:"header_names" api:"required"`
// HTTP method.
Method ScanGetResponseReportReportTestsStepsRequestMethod `json:"method" api:"required"`
// Exact and full URL (including host, query parameters) that was requested.
URL string `json:"url" api:"required" format:"uri"`
// Variable captures requested for this step.
VariableCaptures []ScanGetResponseReportReportTestsStepsRequestVariableCapture `json:"variable_captures" api:"required"`
// Request body, if any.
Body interface{} `json:"body" api:"nullable"`
JSON scanGetResponseReportReportTestsStepsRequestJSON `json:"-"`
}
HTTP request that was made, if any.
func (*ScanGetResponseReportReportTestsStepsRequest) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsRequest) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsRequestCredentialSet ¶
type ScanGetResponseReportReportTestsStepsRequestCredentialSet struct {
// ID of the credential set.
ID string `json:"id" api:"required" format:"uuid"`
// Role of the credential set.
Role ScanGetResponseReportReportTestsStepsRequestCredentialSetRole `json:"role" api:"required"`
JSON scanGetResponseReportReportTestsStepsRequestCredentialSetJSON `json:"-"`
}
Credential set that was used.
func (*ScanGetResponseReportReportTestsStepsRequestCredentialSet) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsRequestCredentialSet) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsRequestCredentialSetRole ¶
type ScanGetResponseReportReportTestsStepsRequestCredentialSetRole string
Role of the credential set.
const ( ScanGetResponseReportReportTestsStepsRequestCredentialSetRoleOwner ScanGetResponseReportReportTestsStepsRequestCredentialSetRole = "owner" ScanGetResponseReportReportTestsStepsRequestCredentialSetRoleAttacker ScanGetResponseReportReportTestsStepsRequestCredentialSetRole = "attacker" )
func (ScanGetResponseReportReportTestsStepsRequestCredentialSetRole) IsKnown ¶
func (r ScanGetResponseReportReportTestsStepsRequestCredentialSetRole) IsKnown() bool
type ScanGetResponseReportReportTestsStepsRequestMethod ¶
type ScanGetResponseReportReportTestsStepsRequestMethod string
HTTP method.
const ( ScanGetResponseReportReportTestsStepsRequestMethodGet ScanGetResponseReportReportTestsStepsRequestMethod = "GET" ScanGetResponseReportReportTestsStepsRequestMethodDelete ScanGetResponseReportReportTestsStepsRequestMethod = "DELETE" ScanGetResponseReportReportTestsStepsRequestMethodPatch ScanGetResponseReportReportTestsStepsRequestMethod = "PATCH" ScanGetResponseReportReportTestsStepsRequestMethodPost ScanGetResponseReportReportTestsStepsRequestMethod = "POST" ScanGetResponseReportReportTestsStepsRequestMethodPut ScanGetResponseReportReportTestsStepsRequestMethod = "PUT" )
func (ScanGetResponseReportReportTestsStepsRequestMethod) IsKnown ¶
func (r ScanGetResponseReportReportTestsStepsRequestMethod) IsKnown() bool
type ScanGetResponseReportReportTestsStepsRequestVariableCapture ¶
type ScanGetResponseReportReportTestsStepsRequestVariableCapture struct {
// JSONPath expression used for capture, e.g. `"$.id"`.
JsonPath string `json:"json_path" api:"required"`
// Variable name, e.g. `"resource_id"`.
Name string `json:"name" api:"required"`
JSON scanGetResponseReportReportTestsStepsRequestVariableCaptureJSON `json:"-"`
}
A variable to capture from the response body.
func (*ScanGetResponseReportReportTestsStepsRequestVariableCapture) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsRequestVariableCapture) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsResponse ¶
type ScanGetResponseReportReportTestsStepsResponse struct {
// HTTP response body.
Body ScanGetResponseReportReportTestsStepsResponseBody `json:"body" api:"required"`
// Names of headers that were received.
HeaderNames []string `json:"header_names" api:"required"`
// HTTP status code.
Status int64 `json:"status" api:"required"`
// HTTP status text, if available for the status code.
StatusText string `json:"status_text" api:"nullable"`
JSON scanGetResponseReportReportTestsStepsResponseJSON `json:"-"`
}
HTTP response that was received, if any.
func (*ScanGetResponseReportReportTestsStepsResponse) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsResponse) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsResponseBody ¶
type ScanGetResponseReportReportTestsStepsResponseBody struct {
Kind ScanGetResponseReportReportTestsStepsResponseBodyKind `json:"kind" api:"required"`
Contents string `json:"contents"`
Truncated bool `json:"truncated"`
JSON scanGetResponseReportReportTestsStepsResponseBodyJSON `json:"-"`
// contains filtered or unexported fields
}
HTTP response body.
func (ScanGetResponseReportReportTestsStepsResponseBody) AsUnion ¶
func (r ScanGetResponseReportReportTestsStepsResponseBody) AsUnion() ScanGetResponseReportReportTestsStepsResponseBodyUnion
AsUnion returns a ScanGetResponseReportReportTestsStepsResponseBodyUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound, ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes, ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText, ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson.
func (*ScanGetResponseReportReportTestsStepsResponseBody) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsResponseBody) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsResponseBodyKind ¶
type ScanGetResponseReportReportTestsStepsResponseBodyKind string
const ( ScanGetResponseReportReportTestsStepsResponseBodyKindNotFound ScanGetResponseReportReportTestsStepsResponseBodyKind = "not_found" ScanGetResponseReportReportTestsStepsResponseBodyKindBytes ScanGetResponseReportReportTestsStepsResponseBodyKind = "bytes" ScanGetResponseReportReportTestsStepsResponseBodyKindText ScanGetResponseReportReportTestsStepsResponseBodyKind = "text" ScanGetResponseReportReportTestsStepsResponseBodyKindJson ScanGetResponseReportReportTestsStepsResponseBodyKind = "json" )
func (ScanGetResponseReportReportTestsStepsResponseBodyKind) IsKnown ¶
func (r ScanGetResponseReportReportTestsStepsResponseBodyKind) IsKnown() bool
type ScanGetResponseReportReportTestsStepsResponseBodyUnion ¶
type ScanGetResponseReportReportTestsStepsResponseBodyUnion interface {
// contains filtered or unexported methods
}
HTTP response body.
Union satisfied by ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound, ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes, ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText or ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson.
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes ¶
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes struct {
Contents string `json:"contents" api:"required"`
Kind ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind `json:"kind" api:"required"`
Truncated bool `json:"truncated" api:"required"`
JSON scanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesJSON `json:"-"`
}
Body received but unable to read as UTF-8. Raw bytes, base64-encoded.
func (*ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind ¶
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind string
const (
ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKindBytes ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind = "bytes"
)
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson ¶
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson struct {
Contents string `json:"contents" api:"required"`
Kind ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind `json:"kind" api:"required"`
Truncated bool `json:"truncated" api:"required"`
JSON scanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonJSON `json:"-"`
}
Body received as valid JSON.
func (*ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind ¶
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind string
const (
ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKindJson ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind = "json"
)
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound ¶
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound struct {
Kind ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind `json:"kind" api:"required"`
JSON scanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundJSON `json:"-"`
}
No body was received.
func (*ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind ¶
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind string
const (
ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKindNotFound ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind = "not_found"
)
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText ¶
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText struct {
Contents string `json:"contents" api:"required"`
Kind ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind `json:"kind" api:"required"`
Truncated bool `json:"truncated" api:"required"`
JSON scanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextJSON `json:"-"`
}
Body received as valid UTF-8 text but not valid JSON.
func (*ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText) UnmarshalJSON ¶
func (r *ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText) UnmarshalJSON(data []byte) (err error)
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind ¶
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind string
const (
ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKindText ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind = "text"
)
type ScanGetResponseReportReportTestsVerdict ¶
type ScanGetResponseReportReportTestsVerdict string
Verdict of this single test.
const ( ScanGetResponseReportReportTestsVerdictOk ScanGetResponseReportReportTestsVerdict = "ok" ScanGetResponseReportReportTestsVerdictWarning ScanGetResponseReportReportTestsVerdict = "warning" ScanGetResponseReportReportTestsVerdictInconclusive ScanGetResponseReportReportTestsVerdict = "inconclusive" )
func (ScanGetResponseReportReportTestsVerdict) IsKnown ¶
func (r ScanGetResponseReportReportTestsVerdict) IsKnown() bool
type ScanGetResponseScanType ¶
type ScanGetResponseScanType string
The type of vulnerability scan.
const (
ScanGetResponseScanTypeBOLA ScanGetResponseScanType = "bola"
)
func (ScanGetResponseScanType) IsKnown ¶
func (r ScanGetResponseScanType) IsKnown() bool
type ScanGetResponseStatus ¶
type ScanGetResponseStatus string
Current lifecycle status of the scan.
const ( ScanGetResponseStatusCreated ScanGetResponseStatus = "created" ScanGetResponseStatusScheduled ScanGetResponseStatus = "scheduled" ScanGetResponseStatusPlanning ScanGetResponseStatus = "planning" ScanGetResponseStatusRunning ScanGetResponseStatus = "running" ScanGetResponseStatusFinished ScanGetResponseStatus = "finished" ScanGetResponseStatusFailed ScanGetResponseStatus = "failed" )
func (ScanGetResponseStatus) IsKnown ¶
func (r ScanGetResponseStatus) IsKnown() bool
type ScanListParams ¶
type ScanListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Page number of paginated results.
Page param.Field[int64] `query:"page"`
// Number of results per page.
PerPage param.Field[int64] `query:"per_page"`
}
func (ScanListParams) URLQuery ¶
func (r ScanListParams) URLQuery() (v url.Values)
URLQuery serializes ScanListParams's query parameters as `url.Values`.
type ScanListResponse ¶
type ScanListResponse struct {
// Scan identifier.
ID string `json:"id" api:"required" format:"uuid"`
// The type of vulnerability scan.
ScanType ScanListResponseScanType `json:"scan_type" api:"required"`
// Current lifecycle status of the scan.
Status ScanListResponseStatus `json:"status" api:"required"`
// The target environment this scan runs against.
TargetEnvironmentID string `json:"target_environment_id" api:"required" format:"uuid"`
// Vulnerability report produced after the scan completes. The shape depends on the
// scan type. Present only for finished scans.
Report ScanListResponseReport `json:"report" api:"nullable"`
JSON scanListResponseJSON `json:"-"`
}
func (*ScanListResponse) UnmarshalJSON ¶
func (r *ScanListResponse) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReport ¶
type ScanListResponseReport struct {
// Version 1 of the BOLA vulnerability scan report.
Report ScanListResponseReportReport `json:"report" api:"required"`
// Version of the report schema.
ReportSchemaVersion ScanListResponseReportReportSchemaVersion `json:"report_schema_version" api:"required"`
JSON scanListResponseReportJSON `json:"-"`
}
Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans.
func (*ScanListResponseReport) UnmarshalJSON ¶
func (r *ScanListResponseReport) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReport ¶
type ScanListResponseReportReport struct {
// Summary of all steps and findings.
Summary ScanListResponseReportReportSummary `json:"summary" api:"required"`
// List of tests that were run.
Tests []ScanListResponseReportReportTest `json:"tests" api:"required"`
JSON scanListResponseReportReportJSON `json:"-"`
}
Version 1 of the BOLA vulnerability scan report.
func (*ScanListResponseReportReport) UnmarshalJSON ¶
func (r *ScanListResponseReportReport) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportSchemaVersion ¶
type ScanListResponseReportReportSchemaVersion string
Version of the report schema.
const (
ScanListResponseReportReportSchemaVersionV1 ScanListResponseReportReportSchemaVersion = "v1"
)
func (ScanListResponseReportReportSchemaVersion) IsKnown ¶
func (r ScanListResponseReportReportSchemaVersion) IsKnown() bool
type ScanListResponseReportReportSummary ¶
type ScanListResponseReportReportSummary struct {
// Overall verdict of the vulnerability scan.
Verdict ScanListResponseReportReportSummaryVerdict `json:"verdict" api:"required"`
JSON scanListResponseReportReportSummaryJSON `json:"-"`
}
Summary of all steps and findings.
func (*ScanListResponseReportReportSummary) UnmarshalJSON ¶
func (r *ScanListResponseReportReportSummary) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportSummaryVerdict ¶
type ScanListResponseReportReportSummaryVerdict string
Overall verdict of the vulnerability scan.
const ( ScanListResponseReportReportSummaryVerdictOk ScanListResponseReportReportSummaryVerdict = "ok" ScanListResponseReportReportSummaryVerdictWarning ScanListResponseReportReportSummaryVerdict = "warning" ScanListResponseReportReportSummaryVerdictInconclusive ScanListResponseReportReportSummaryVerdict = "inconclusive" )
func (ScanListResponseReportReportSummaryVerdict) IsKnown ¶
func (r ScanListResponseReportReportSummaryVerdict) IsKnown() bool
type ScanListResponseReportReportTest ¶
type ScanListResponseReportReportTest struct {
// Steps that were executed.
Steps []ScanListResponseReportReportTestsStep `json:"steps" api:"required"`
// Verdict of this single test.
Verdict ScanListResponseReportReportTestsVerdict `json:"verdict" api:"required"`
// Errors that prevented step execution.
PreflightErrors []ScanListResponseReportReportTestsPreflightError `json:"preflight_errors"`
JSON scanListResponseReportReportTestJSON `json:"-"`
}
Result of a single test.
func (*ScanListResponseReportReportTest) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTest) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsPreflightError ¶
type ScanListResponseReportReportTestsPreflightError struct {
// Human-readable error description.
Description string `json:"description" api:"required"`
// Numeric error code identifying the class of error, if available.
ErrorCode int64 `json:"error_code" api:"nullable"`
JSON scanListResponseReportReportTestsPreflightErrorJSON `json:"-"`
}
Error that occurred during a test.
func (*ScanListResponseReportReportTestsPreflightError) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsPreflightError) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStep ¶
type ScanListResponseReportReportTestsStep struct {
// Assertions that were made against the received response.
Assertions []ScanListResponseReportReportTestsStepsAssertion `json:"assertions" api:"required"`
// Errors the step encountered that may explain absent or incomplete fields.
Errors []ScanListResponseReportReportTestsStepsError `json:"errors"`
// HTTP request that was made, if any.
Request ScanListResponseReportReportTestsStepsRequest `json:"request" api:"nullable"`
// HTTP response that was received, if any.
Response ScanListResponseReportReportTestsStepsResponse `json:"response" api:"nullable"`
JSON scanListResponseReportReportTestsStepJSON `json:"-"`
}
A single step in a test.
func (*ScanListResponseReportReportTestsStep) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStep) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsAssertion ¶
type ScanListResponseReportReportTestsStepsAssertion struct {
// Human-readable description of the assertion, explaining what was checked.
Description string `json:"description" api:"required"`
// Kind of assertion.
Kind ScanListResponseReportReportTestsStepsAssertionsKind `json:"kind" api:"required"`
// Observed value on which the assertion was made.
Observed int64 `json:"observed" api:"required,nullable"`
// Outcome of the assertion.
Outcome ScanListResponseReportReportTestsStepsAssertionsOutcome `json:"outcome" api:"required"`
JSON scanListResponseReportReportTestsStepsAssertionJSON `json:"-"`
}
Assertion that was made against the received response.
func (*ScanListResponseReportReportTestsStepsAssertion) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsAssertion) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsAssertionsKind ¶
type ScanListResponseReportReportTestsStepsAssertionsKind struct {
// Range of HTTP status codes.
Parameters ScanListResponseReportReportTestsStepsAssertionsKindParameters `json:"parameters" api:"required"`
Type ScanListResponseReportReportTestsStepsAssertionsKindType `json:"type" api:"required"`
JSON scanListResponseReportReportTestsStepsAssertionsKindJSON `json:"-"`
}
Kind of assertion.
func (*ScanListResponseReportReportTestsStepsAssertionsKind) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsAssertionsKind) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsAssertionsKindParameters ¶
type ScanListResponseReportReportTestsStepsAssertionsKindParameters struct {
// Maximum (inclusive) status code of the range.
Max int64 `json:"max" api:"required"`
// Minimum (inclusive) status code of the range.
Min int64 `json:"min" api:"required"`
JSON scanListResponseReportReportTestsStepsAssertionsKindParametersJSON `json:"-"`
}
Range of HTTP status codes.
func (*ScanListResponseReportReportTestsStepsAssertionsKindParameters) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsAssertionsKindParameters) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsAssertionsKindType ¶
type ScanListResponseReportReportTestsStepsAssertionsKindType string
const (
ScanListResponseReportReportTestsStepsAssertionsKindTypeHTTPStatusWithinRange ScanListResponseReportReportTestsStepsAssertionsKindType = "http_status_within_range"
)
func (ScanListResponseReportReportTestsStepsAssertionsKindType) IsKnown ¶
func (r ScanListResponseReportReportTestsStepsAssertionsKindType) IsKnown() bool
type ScanListResponseReportReportTestsStepsAssertionsOutcome ¶
type ScanListResponseReportReportTestsStepsAssertionsOutcome string
Outcome of the assertion.
const ( ScanListResponseReportReportTestsStepsAssertionsOutcomeOk ScanListResponseReportReportTestsStepsAssertionsOutcome = "ok" ScanListResponseReportReportTestsStepsAssertionsOutcomeFail ScanListResponseReportReportTestsStepsAssertionsOutcome = "fail" ScanListResponseReportReportTestsStepsAssertionsOutcomeInconclusive ScanListResponseReportReportTestsStepsAssertionsOutcome = "inconclusive" )
func (ScanListResponseReportReportTestsStepsAssertionsOutcome) IsKnown ¶
func (r ScanListResponseReportReportTestsStepsAssertionsOutcome) IsKnown() bool
type ScanListResponseReportReportTestsStepsError ¶
type ScanListResponseReportReportTestsStepsError struct {
// Human-readable error description.
Description string `json:"description" api:"required"`
// Numeric error code identifying the class of error, if available.
ErrorCode int64 `json:"error_code" api:"nullable"`
JSON scanListResponseReportReportTestsStepsErrorJSON `json:"-"`
}
Error that occurred during a test.
func (*ScanListResponseReportReportTestsStepsError) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsError) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsRequest ¶
type ScanListResponseReportReportTestsStepsRequest struct {
// Credential set that was used.
CredentialSet ScanListResponseReportReportTestsStepsRequestCredentialSet `json:"credential_set" api:"required"`
// Names of headers that were sent.
HeaderNames []string `json:"header_names" api:"required"`
// HTTP method.
Method ScanListResponseReportReportTestsStepsRequestMethod `json:"method" api:"required"`
// Exact and full URL (including host, query parameters) that was requested.
URL string `json:"url" api:"required" format:"uri"`
// Variable captures requested for this step.
VariableCaptures []ScanListResponseReportReportTestsStepsRequestVariableCapture `json:"variable_captures" api:"required"`
// Request body, if any.
Body interface{} `json:"body" api:"nullable"`
JSON scanListResponseReportReportTestsStepsRequestJSON `json:"-"`
}
HTTP request that was made, if any.
func (*ScanListResponseReportReportTestsStepsRequest) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsRequest) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsRequestCredentialSet ¶
type ScanListResponseReportReportTestsStepsRequestCredentialSet struct {
// ID of the credential set.
ID string `json:"id" api:"required" format:"uuid"`
// Role of the credential set.
Role ScanListResponseReportReportTestsStepsRequestCredentialSetRole `json:"role" api:"required"`
JSON scanListResponseReportReportTestsStepsRequestCredentialSetJSON `json:"-"`
}
Credential set that was used.
func (*ScanListResponseReportReportTestsStepsRequestCredentialSet) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsRequestCredentialSet) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsRequestCredentialSetRole ¶
type ScanListResponseReportReportTestsStepsRequestCredentialSetRole string
Role of the credential set.
const ( ScanListResponseReportReportTestsStepsRequestCredentialSetRoleOwner ScanListResponseReportReportTestsStepsRequestCredentialSetRole = "owner" ScanListResponseReportReportTestsStepsRequestCredentialSetRoleAttacker ScanListResponseReportReportTestsStepsRequestCredentialSetRole = "attacker" )
func (ScanListResponseReportReportTestsStepsRequestCredentialSetRole) IsKnown ¶
func (r ScanListResponseReportReportTestsStepsRequestCredentialSetRole) IsKnown() bool
type ScanListResponseReportReportTestsStepsRequestMethod ¶
type ScanListResponseReportReportTestsStepsRequestMethod string
HTTP method.
const ( ScanListResponseReportReportTestsStepsRequestMethodGet ScanListResponseReportReportTestsStepsRequestMethod = "GET" ScanListResponseReportReportTestsStepsRequestMethodDelete ScanListResponseReportReportTestsStepsRequestMethod = "DELETE" ScanListResponseReportReportTestsStepsRequestMethodPatch ScanListResponseReportReportTestsStepsRequestMethod = "PATCH" ScanListResponseReportReportTestsStepsRequestMethodPost ScanListResponseReportReportTestsStepsRequestMethod = "POST" ScanListResponseReportReportTestsStepsRequestMethodPut ScanListResponseReportReportTestsStepsRequestMethod = "PUT" )
func (ScanListResponseReportReportTestsStepsRequestMethod) IsKnown ¶
func (r ScanListResponseReportReportTestsStepsRequestMethod) IsKnown() bool
type ScanListResponseReportReportTestsStepsRequestVariableCapture ¶
type ScanListResponseReportReportTestsStepsRequestVariableCapture struct {
// JSONPath expression used for capture, e.g. `"$.id"`.
JsonPath string `json:"json_path" api:"required"`
// Variable name, e.g. `"resource_id"`.
Name string `json:"name" api:"required"`
JSON scanListResponseReportReportTestsStepsRequestVariableCaptureJSON `json:"-"`
}
A variable to capture from the response body.
func (*ScanListResponseReportReportTestsStepsRequestVariableCapture) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsRequestVariableCapture) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsResponse ¶
type ScanListResponseReportReportTestsStepsResponse struct {
// HTTP response body.
Body ScanListResponseReportReportTestsStepsResponseBody `json:"body" api:"required"`
// Names of headers that were received.
HeaderNames []string `json:"header_names" api:"required"`
// HTTP status code.
Status int64 `json:"status" api:"required"`
// HTTP status text, if available for the status code.
StatusText string `json:"status_text" api:"nullable"`
JSON scanListResponseReportReportTestsStepsResponseJSON `json:"-"`
}
HTTP response that was received, if any.
func (*ScanListResponseReportReportTestsStepsResponse) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsResponse) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsResponseBody ¶
type ScanListResponseReportReportTestsStepsResponseBody struct {
Kind ScanListResponseReportReportTestsStepsResponseBodyKind `json:"kind" api:"required"`
Contents string `json:"contents"`
Truncated bool `json:"truncated"`
JSON scanListResponseReportReportTestsStepsResponseBodyJSON `json:"-"`
// contains filtered or unexported fields
}
HTTP response body.
func (ScanListResponseReportReportTestsStepsResponseBody) AsUnion ¶
func (r ScanListResponseReportReportTestsStepsResponseBody) AsUnion() ScanListResponseReportReportTestsStepsResponseBodyUnion
AsUnion returns a ScanListResponseReportReportTestsStepsResponseBodyUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound, ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes, ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText, ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson.
func (*ScanListResponseReportReportTestsStepsResponseBody) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsResponseBody) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsResponseBodyKind ¶
type ScanListResponseReportReportTestsStepsResponseBodyKind string
const ( ScanListResponseReportReportTestsStepsResponseBodyKindNotFound ScanListResponseReportReportTestsStepsResponseBodyKind = "not_found" ScanListResponseReportReportTestsStepsResponseBodyKindBytes ScanListResponseReportReportTestsStepsResponseBodyKind = "bytes" ScanListResponseReportReportTestsStepsResponseBodyKindText ScanListResponseReportReportTestsStepsResponseBodyKind = "text" ScanListResponseReportReportTestsStepsResponseBodyKindJson ScanListResponseReportReportTestsStepsResponseBodyKind = "json" )
func (ScanListResponseReportReportTestsStepsResponseBodyKind) IsKnown ¶
func (r ScanListResponseReportReportTestsStepsResponseBodyKind) IsKnown() bool
type ScanListResponseReportReportTestsStepsResponseBodyUnion ¶
type ScanListResponseReportReportTestsStepsResponseBodyUnion interface {
// contains filtered or unexported methods
}
HTTP response body.
Union satisfied by ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound, ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes, ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText or ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson.
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes ¶
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes struct {
Contents string `json:"contents" api:"required"`
Kind ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind `json:"kind" api:"required"`
Truncated bool `json:"truncated" api:"required"`
JSON scanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesJSON `json:"-"`
}
Body received but unable to read as UTF-8. Raw bytes, base64-encoded.
func (*ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind ¶
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind string
const (
ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKindBytes ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind = "bytes"
)
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson ¶
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson struct {
Contents string `json:"contents" api:"required"`
Kind ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind `json:"kind" api:"required"`
Truncated bool `json:"truncated" api:"required"`
JSON scanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonJSON `json:"-"`
}
Body received as valid JSON.
func (*ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind ¶
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind string
const (
ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKindJson ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind = "json"
)
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound ¶
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound struct {
Kind ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind `json:"kind" api:"required"`
JSON scanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundJSON `json:"-"`
}
No body was received.
func (*ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind ¶
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind string
const (
ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKindNotFound ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind = "not_found"
)
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText ¶
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText struct {
Contents string `json:"contents" api:"required"`
Kind ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind `json:"kind" api:"required"`
Truncated bool `json:"truncated" api:"required"`
JSON scanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextJSON `json:"-"`
}
Body received as valid UTF-8 text but not valid JSON.
func (*ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText) UnmarshalJSON ¶
func (r *ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText) UnmarshalJSON(data []byte) (err error)
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind ¶
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind string
const (
ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKindText ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind = "text"
)
type ScanListResponseReportReportTestsVerdict ¶
type ScanListResponseReportReportTestsVerdict string
Verdict of this single test.
const ( ScanListResponseReportReportTestsVerdictOk ScanListResponseReportReportTestsVerdict = "ok" ScanListResponseReportReportTestsVerdictWarning ScanListResponseReportReportTestsVerdict = "warning" ScanListResponseReportReportTestsVerdictInconclusive ScanListResponseReportReportTestsVerdict = "inconclusive" )
func (ScanListResponseReportReportTestsVerdict) IsKnown ¶
func (r ScanListResponseReportReportTestsVerdict) IsKnown() bool
type ScanListResponseScanType ¶
type ScanListResponseScanType string
The type of vulnerability scan.
const (
ScanListResponseScanTypeBOLA ScanListResponseScanType = "bola"
)
func (ScanListResponseScanType) IsKnown ¶
func (r ScanListResponseScanType) IsKnown() bool
type ScanListResponseStatus ¶
type ScanListResponseStatus string
Current lifecycle status of the scan.
const ( ScanListResponseStatusCreated ScanListResponseStatus = "created" ScanListResponseStatusScheduled ScanListResponseStatus = "scheduled" ScanListResponseStatusPlanning ScanListResponseStatus = "planning" ScanListResponseStatusRunning ScanListResponseStatus = "running" ScanListResponseStatusFinished ScanListResponseStatus = "finished" ScanListResponseStatusFailed ScanListResponseStatus = "failed" )
func (ScanListResponseStatus) IsKnown ¶
func (r ScanListResponseStatus) IsKnown() bool
type ScanNewParams ¶
type ScanNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Credential set references for a BOLA scan. The scanner uses the `owner`
// credentials for legitimate requests and the `attacker` credentials to attempt
// unauthorized access.
CredentialSets param.Field[ScanNewParamsCredentialSets] `json:"credential_sets" api:"required"`
// OpenAPI schema definition for the API under test. The scanner uses this to
// discover endpoints and construct requests.
OpenAPI param.Field[string] `json:"open_api" api:"required"`
ScanType param.Field[ScanNewParamsScanType] `json:"scan_type" api:"required"`
// The target environment to scan.
TargetEnvironmentID param.Field[string] `json:"target_environment_id" api:"required" format:"uuid"`
}
func (ScanNewParams) MarshalJSON ¶
func (r ScanNewParams) MarshalJSON() (data []byte, err error)
type ScanNewParamsCredentialSets ¶
type ScanNewParamsCredentialSets struct {
// Credential set ID for the attacker.
Attacker param.Field[string] `json:"attacker" api:"required" format:"uuid"`
// Credential set ID for the resource owner.
Owner param.Field[string] `json:"owner" api:"required" format:"uuid"`
}
Credential set references for a BOLA scan. The scanner uses the `owner` credentials for legitimate requests and the `attacker` credentials to attempt unauthorized access.
func (ScanNewParamsCredentialSets) MarshalJSON ¶
func (r ScanNewParamsCredentialSets) MarshalJSON() (data []byte, err error)
type ScanNewParamsScanType ¶
type ScanNewParamsScanType string
const (
ScanNewParamsScanTypeBOLA ScanNewParamsScanType = "bola"
)
func (ScanNewParamsScanType) IsKnown ¶
func (r ScanNewParamsScanType) IsKnown() bool
type ScanNewResponse ¶
type ScanNewResponse struct {
// Scan identifier.
ID string `json:"id" api:"required" format:"uuid"`
// The type of vulnerability scan.
ScanType ScanNewResponseScanType `json:"scan_type" api:"required"`
// Current lifecycle status of the scan.
Status ScanNewResponseStatus `json:"status" api:"required"`
// The target environment this scan runs against.
TargetEnvironmentID string `json:"target_environment_id" api:"required" format:"uuid"`
// Vulnerability report produced after the scan completes. The shape depends on the
// scan type. Present only for finished scans.
Report ScanNewResponseReport `json:"report" api:"nullable"`
JSON scanNewResponseJSON `json:"-"`
}
func (*ScanNewResponse) UnmarshalJSON ¶
func (r *ScanNewResponse) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseEnvelope ¶
type ScanNewResponseEnvelope struct {
Errors []ScanNewResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ScanNewResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success ScanNewResponseEnvelopeSuccess `json:"success" api:"required"`
Result ScanNewResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON scanNewResponseEnvelopeJSON `json:"-"`
}
func (*ScanNewResponseEnvelope) UnmarshalJSON ¶
func (r *ScanNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseEnvelopeErrors ¶
type ScanNewResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ScanNewResponseEnvelopeErrorsSource `json:"source"`
JSON scanNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ScanNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ScanNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseEnvelopeErrorsSource ¶
type ScanNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON scanNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ScanNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ScanNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseEnvelopeMessages ¶
type ScanNewResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ScanNewResponseEnvelopeMessagesSource `json:"source"`
JSON scanNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ScanNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ScanNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseEnvelopeMessagesSource ¶
type ScanNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON scanNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ScanNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *ScanNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseEnvelopeSuccess ¶
type ScanNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ScanNewResponseEnvelopeSuccessTrue ScanNewResponseEnvelopeSuccess = true
)
func (ScanNewResponseEnvelopeSuccess) IsKnown ¶
func (r ScanNewResponseEnvelopeSuccess) IsKnown() bool
type ScanNewResponseReport ¶
type ScanNewResponseReport struct {
// Version 1 of the BOLA vulnerability scan report.
Report ScanNewResponseReportReport `json:"report" api:"required"`
// Version of the report schema.
ReportSchemaVersion ScanNewResponseReportReportSchemaVersion `json:"report_schema_version" api:"required"`
JSON scanNewResponseReportJSON `json:"-"`
}
Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans.
func (*ScanNewResponseReport) UnmarshalJSON ¶
func (r *ScanNewResponseReport) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReport ¶
type ScanNewResponseReportReport struct {
// Summary of all steps and findings.
Summary ScanNewResponseReportReportSummary `json:"summary" api:"required"`
// List of tests that were run.
Tests []ScanNewResponseReportReportTest `json:"tests" api:"required"`
JSON scanNewResponseReportReportJSON `json:"-"`
}
Version 1 of the BOLA vulnerability scan report.
func (*ScanNewResponseReportReport) UnmarshalJSON ¶
func (r *ScanNewResponseReportReport) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportSchemaVersion ¶
type ScanNewResponseReportReportSchemaVersion string
Version of the report schema.
const (
ScanNewResponseReportReportSchemaVersionV1 ScanNewResponseReportReportSchemaVersion = "v1"
)
func (ScanNewResponseReportReportSchemaVersion) IsKnown ¶
func (r ScanNewResponseReportReportSchemaVersion) IsKnown() bool
type ScanNewResponseReportReportSummary ¶
type ScanNewResponseReportReportSummary struct {
// Overall verdict of the vulnerability scan.
Verdict ScanNewResponseReportReportSummaryVerdict `json:"verdict" api:"required"`
JSON scanNewResponseReportReportSummaryJSON `json:"-"`
}
Summary of all steps and findings.
func (*ScanNewResponseReportReportSummary) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportSummary) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportSummaryVerdict ¶
type ScanNewResponseReportReportSummaryVerdict string
Overall verdict of the vulnerability scan.
const ( ScanNewResponseReportReportSummaryVerdictOk ScanNewResponseReportReportSummaryVerdict = "ok" ScanNewResponseReportReportSummaryVerdictWarning ScanNewResponseReportReportSummaryVerdict = "warning" ScanNewResponseReportReportSummaryVerdictInconclusive ScanNewResponseReportReportSummaryVerdict = "inconclusive" )
func (ScanNewResponseReportReportSummaryVerdict) IsKnown ¶
func (r ScanNewResponseReportReportSummaryVerdict) IsKnown() bool
type ScanNewResponseReportReportTest ¶
type ScanNewResponseReportReportTest struct {
// Steps that were executed.
Steps []ScanNewResponseReportReportTestsStep `json:"steps" api:"required"`
// Verdict of this single test.
Verdict ScanNewResponseReportReportTestsVerdict `json:"verdict" api:"required"`
// Errors that prevented step execution.
PreflightErrors []ScanNewResponseReportReportTestsPreflightError `json:"preflight_errors"`
JSON scanNewResponseReportReportTestJSON `json:"-"`
}
Result of a single test.
func (*ScanNewResponseReportReportTest) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTest) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsPreflightError ¶
type ScanNewResponseReportReportTestsPreflightError struct {
// Human-readable error description.
Description string `json:"description" api:"required"`
// Numeric error code identifying the class of error, if available.
ErrorCode int64 `json:"error_code" api:"nullable"`
JSON scanNewResponseReportReportTestsPreflightErrorJSON `json:"-"`
}
Error that occurred during a test.
func (*ScanNewResponseReportReportTestsPreflightError) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsPreflightError) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStep ¶
type ScanNewResponseReportReportTestsStep struct {
// Assertions that were made against the received response.
Assertions []ScanNewResponseReportReportTestsStepsAssertion `json:"assertions" api:"required"`
// Errors the step encountered that may explain absent or incomplete fields.
Errors []ScanNewResponseReportReportTestsStepsError `json:"errors"`
// HTTP request that was made, if any.
Request ScanNewResponseReportReportTestsStepsRequest `json:"request" api:"nullable"`
// HTTP response that was received, if any.
Response ScanNewResponseReportReportTestsStepsResponse `json:"response" api:"nullable"`
JSON scanNewResponseReportReportTestsStepJSON `json:"-"`
}
A single step in a test.
func (*ScanNewResponseReportReportTestsStep) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStep) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsAssertion ¶
type ScanNewResponseReportReportTestsStepsAssertion struct {
// Human-readable description of the assertion, explaining what was checked.
Description string `json:"description" api:"required"`
// Kind of assertion.
Kind ScanNewResponseReportReportTestsStepsAssertionsKind `json:"kind" api:"required"`
// Observed value on which the assertion was made.
Observed int64 `json:"observed" api:"required,nullable"`
// Outcome of the assertion.
Outcome ScanNewResponseReportReportTestsStepsAssertionsOutcome `json:"outcome" api:"required"`
JSON scanNewResponseReportReportTestsStepsAssertionJSON `json:"-"`
}
Assertion that was made against the received response.
func (*ScanNewResponseReportReportTestsStepsAssertion) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsAssertion) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsAssertionsKind ¶
type ScanNewResponseReportReportTestsStepsAssertionsKind struct {
// Range of HTTP status codes.
Parameters ScanNewResponseReportReportTestsStepsAssertionsKindParameters `json:"parameters" api:"required"`
Type ScanNewResponseReportReportTestsStepsAssertionsKindType `json:"type" api:"required"`
JSON scanNewResponseReportReportTestsStepsAssertionsKindJSON `json:"-"`
}
Kind of assertion.
func (*ScanNewResponseReportReportTestsStepsAssertionsKind) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsAssertionsKind) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsAssertionsKindParameters ¶
type ScanNewResponseReportReportTestsStepsAssertionsKindParameters struct {
// Maximum (inclusive) status code of the range.
Max int64 `json:"max" api:"required"`
// Minimum (inclusive) status code of the range.
Min int64 `json:"min" api:"required"`
JSON scanNewResponseReportReportTestsStepsAssertionsKindParametersJSON `json:"-"`
}
Range of HTTP status codes.
func (*ScanNewResponseReportReportTestsStepsAssertionsKindParameters) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsAssertionsKindParameters) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsAssertionsKindType ¶
type ScanNewResponseReportReportTestsStepsAssertionsKindType string
const (
ScanNewResponseReportReportTestsStepsAssertionsKindTypeHTTPStatusWithinRange ScanNewResponseReportReportTestsStepsAssertionsKindType = "http_status_within_range"
)
func (ScanNewResponseReportReportTestsStepsAssertionsKindType) IsKnown ¶
func (r ScanNewResponseReportReportTestsStepsAssertionsKindType) IsKnown() bool
type ScanNewResponseReportReportTestsStepsAssertionsOutcome ¶
type ScanNewResponseReportReportTestsStepsAssertionsOutcome string
Outcome of the assertion.
const ( ScanNewResponseReportReportTestsStepsAssertionsOutcomeOk ScanNewResponseReportReportTestsStepsAssertionsOutcome = "ok" ScanNewResponseReportReportTestsStepsAssertionsOutcomeFail ScanNewResponseReportReportTestsStepsAssertionsOutcome = "fail" ScanNewResponseReportReportTestsStepsAssertionsOutcomeInconclusive ScanNewResponseReportReportTestsStepsAssertionsOutcome = "inconclusive" )
func (ScanNewResponseReportReportTestsStepsAssertionsOutcome) IsKnown ¶
func (r ScanNewResponseReportReportTestsStepsAssertionsOutcome) IsKnown() bool
type ScanNewResponseReportReportTestsStepsError ¶
type ScanNewResponseReportReportTestsStepsError struct {
// Human-readable error description.
Description string `json:"description" api:"required"`
// Numeric error code identifying the class of error, if available.
ErrorCode int64 `json:"error_code" api:"nullable"`
JSON scanNewResponseReportReportTestsStepsErrorJSON `json:"-"`
}
Error that occurred during a test.
func (*ScanNewResponseReportReportTestsStepsError) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsError) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsRequest ¶
type ScanNewResponseReportReportTestsStepsRequest struct {
// Credential set that was used.
CredentialSet ScanNewResponseReportReportTestsStepsRequestCredentialSet `json:"credential_set" api:"required"`
// Names of headers that were sent.
HeaderNames []string `json:"header_names" api:"required"`
// HTTP method.
Method ScanNewResponseReportReportTestsStepsRequestMethod `json:"method" api:"required"`
// Exact and full URL (including host, query parameters) that was requested.
URL string `json:"url" api:"required" format:"uri"`
// Variable captures requested for this step.
VariableCaptures []ScanNewResponseReportReportTestsStepsRequestVariableCapture `json:"variable_captures" api:"required"`
// Request body, if any.
Body interface{} `json:"body" api:"nullable"`
JSON scanNewResponseReportReportTestsStepsRequestJSON `json:"-"`
}
HTTP request that was made, if any.
func (*ScanNewResponseReportReportTestsStepsRequest) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsRequest) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsRequestCredentialSet ¶
type ScanNewResponseReportReportTestsStepsRequestCredentialSet struct {
// ID of the credential set.
ID string `json:"id" api:"required" format:"uuid"`
// Role of the credential set.
Role ScanNewResponseReportReportTestsStepsRequestCredentialSetRole `json:"role" api:"required"`
JSON scanNewResponseReportReportTestsStepsRequestCredentialSetJSON `json:"-"`
}
Credential set that was used.
func (*ScanNewResponseReportReportTestsStepsRequestCredentialSet) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsRequestCredentialSet) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsRequestCredentialSetRole ¶
type ScanNewResponseReportReportTestsStepsRequestCredentialSetRole string
Role of the credential set.
const ( ScanNewResponseReportReportTestsStepsRequestCredentialSetRoleOwner ScanNewResponseReportReportTestsStepsRequestCredentialSetRole = "owner" ScanNewResponseReportReportTestsStepsRequestCredentialSetRoleAttacker ScanNewResponseReportReportTestsStepsRequestCredentialSetRole = "attacker" )
func (ScanNewResponseReportReportTestsStepsRequestCredentialSetRole) IsKnown ¶
func (r ScanNewResponseReportReportTestsStepsRequestCredentialSetRole) IsKnown() bool
type ScanNewResponseReportReportTestsStepsRequestMethod ¶
type ScanNewResponseReportReportTestsStepsRequestMethod string
HTTP method.
const ( ScanNewResponseReportReportTestsStepsRequestMethodGet ScanNewResponseReportReportTestsStepsRequestMethod = "GET" ScanNewResponseReportReportTestsStepsRequestMethodDelete ScanNewResponseReportReportTestsStepsRequestMethod = "DELETE" ScanNewResponseReportReportTestsStepsRequestMethodPatch ScanNewResponseReportReportTestsStepsRequestMethod = "PATCH" ScanNewResponseReportReportTestsStepsRequestMethodPost ScanNewResponseReportReportTestsStepsRequestMethod = "POST" ScanNewResponseReportReportTestsStepsRequestMethodPut ScanNewResponseReportReportTestsStepsRequestMethod = "PUT" )
func (ScanNewResponseReportReportTestsStepsRequestMethod) IsKnown ¶
func (r ScanNewResponseReportReportTestsStepsRequestMethod) IsKnown() bool
type ScanNewResponseReportReportTestsStepsRequestVariableCapture ¶
type ScanNewResponseReportReportTestsStepsRequestVariableCapture struct {
// JSONPath expression used for capture, e.g. `"$.id"`.
JsonPath string `json:"json_path" api:"required"`
// Variable name, e.g. `"resource_id"`.
Name string `json:"name" api:"required"`
JSON scanNewResponseReportReportTestsStepsRequestVariableCaptureJSON `json:"-"`
}
A variable to capture from the response body.
func (*ScanNewResponseReportReportTestsStepsRequestVariableCapture) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsRequestVariableCapture) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsResponse ¶
type ScanNewResponseReportReportTestsStepsResponse struct {
// HTTP response body.
Body ScanNewResponseReportReportTestsStepsResponseBody `json:"body" api:"required"`
// Names of headers that were received.
HeaderNames []string `json:"header_names" api:"required"`
// HTTP status code.
Status int64 `json:"status" api:"required"`
// HTTP status text, if available for the status code.
StatusText string `json:"status_text" api:"nullable"`
JSON scanNewResponseReportReportTestsStepsResponseJSON `json:"-"`
}
HTTP response that was received, if any.
func (*ScanNewResponseReportReportTestsStepsResponse) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsResponse) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsResponseBody ¶
type ScanNewResponseReportReportTestsStepsResponseBody struct {
Kind ScanNewResponseReportReportTestsStepsResponseBodyKind `json:"kind" api:"required"`
Contents string `json:"contents"`
Truncated bool `json:"truncated"`
JSON scanNewResponseReportReportTestsStepsResponseBodyJSON `json:"-"`
// contains filtered or unexported fields
}
HTTP response body.
func (ScanNewResponseReportReportTestsStepsResponseBody) AsUnion ¶
func (r ScanNewResponseReportReportTestsStepsResponseBody) AsUnion() ScanNewResponseReportReportTestsStepsResponseBodyUnion
AsUnion returns a ScanNewResponseReportReportTestsStepsResponseBodyUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound, ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes, ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText, ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson.
func (*ScanNewResponseReportReportTestsStepsResponseBody) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsResponseBody) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsResponseBodyKind ¶
type ScanNewResponseReportReportTestsStepsResponseBodyKind string
const ( ScanNewResponseReportReportTestsStepsResponseBodyKindNotFound ScanNewResponseReportReportTestsStepsResponseBodyKind = "not_found" ScanNewResponseReportReportTestsStepsResponseBodyKindBytes ScanNewResponseReportReportTestsStepsResponseBodyKind = "bytes" ScanNewResponseReportReportTestsStepsResponseBodyKindText ScanNewResponseReportReportTestsStepsResponseBodyKind = "text" ScanNewResponseReportReportTestsStepsResponseBodyKindJson ScanNewResponseReportReportTestsStepsResponseBodyKind = "json" )
func (ScanNewResponseReportReportTestsStepsResponseBodyKind) IsKnown ¶
func (r ScanNewResponseReportReportTestsStepsResponseBodyKind) IsKnown() bool
type ScanNewResponseReportReportTestsStepsResponseBodyUnion ¶
type ScanNewResponseReportReportTestsStepsResponseBodyUnion interface {
// contains filtered or unexported methods
}
HTTP response body.
Union satisfied by ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound, ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes, ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText or ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson.
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes ¶
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes struct {
Contents string `json:"contents" api:"required"`
Kind ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind `json:"kind" api:"required"`
Truncated bool `json:"truncated" api:"required"`
JSON scanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesJSON `json:"-"`
}
Body received but unable to read as UTF-8. Raw bytes, base64-encoded.
func (*ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind ¶
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind string
const (
ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKindBytes ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind = "bytes"
)
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson ¶
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson struct {
Contents string `json:"contents" api:"required"`
Kind ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind `json:"kind" api:"required"`
Truncated bool `json:"truncated" api:"required"`
JSON scanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonJSON `json:"-"`
}
Body received as valid JSON.
func (*ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind ¶
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind string
const (
ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKindJson ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind = "json"
)
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound ¶
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound struct {
Kind ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind `json:"kind" api:"required"`
JSON scanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundJSON `json:"-"`
}
No body was received.
func (*ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind ¶
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind string
const (
ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKindNotFound ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind = "not_found"
)
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText ¶
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText struct {
Contents string `json:"contents" api:"required"`
Kind ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind `json:"kind" api:"required"`
Truncated bool `json:"truncated" api:"required"`
JSON scanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextJSON `json:"-"`
}
Body received as valid UTF-8 text but not valid JSON.
func (*ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText) UnmarshalJSON ¶
func (r *ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText) UnmarshalJSON(data []byte) (err error)
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind ¶
type ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind string
const (
ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKindText ScanNewResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind = "text"
)
type ScanNewResponseReportReportTestsVerdict ¶
type ScanNewResponseReportReportTestsVerdict string
Verdict of this single test.
const ( ScanNewResponseReportReportTestsVerdictOk ScanNewResponseReportReportTestsVerdict = "ok" ScanNewResponseReportReportTestsVerdictWarning ScanNewResponseReportReportTestsVerdict = "warning" ScanNewResponseReportReportTestsVerdictInconclusive ScanNewResponseReportReportTestsVerdict = "inconclusive" )
func (ScanNewResponseReportReportTestsVerdict) IsKnown ¶
func (r ScanNewResponseReportReportTestsVerdict) IsKnown() bool
type ScanNewResponseScanType ¶
type ScanNewResponseScanType string
The type of vulnerability scan.
const (
ScanNewResponseScanTypeBOLA ScanNewResponseScanType = "bola"
)
func (ScanNewResponseScanType) IsKnown ¶
func (r ScanNewResponseScanType) IsKnown() bool
type ScanNewResponseStatus ¶
type ScanNewResponseStatus string
Current lifecycle status of the scan.
const ( ScanNewResponseStatusCreated ScanNewResponseStatus = "created" ScanNewResponseStatusScheduled ScanNewResponseStatus = "scheduled" ScanNewResponseStatusPlanning ScanNewResponseStatus = "planning" ScanNewResponseStatusRunning ScanNewResponseStatus = "running" ScanNewResponseStatusFinished ScanNewResponseStatus = "finished" ScanNewResponseStatusFailed ScanNewResponseStatus = "failed" )
func (ScanNewResponseStatus) IsKnown ¶
func (r ScanNewResponseStatus) IsKnown() bool
type ScanService ¶
type ScanService struct {
Options []option.RequestOption
}
ScanService 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 NewScanService method instead.
func NewScanService ¶
func NewScanService(opts ...option.RequestOption) (r *ScanService)
NewScanService 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 (*ScanService) Get ¶
func (r *ScanService) Get(ctx context.Context, scanID string, query ScanGetParams, opts ...option.RequestOption) (res *ScanGetResponse, err error)
Returns a single scan by ID.
func (*ScanService) List ¶
func (r *ScanService) List(ctx context.Context, params ScanListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[ScanListResponse], err error)
Returns all scans for the account.
func (*ScanService) ListAutoPaging ¶
func (r *ScanService) ListAutoPaging(ctx context.Context, params ScanListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[ScanListResponse]
Returns all scans for the account.
func (*ScanService) New ¶
func (r *ScanService) New(ctx context.Context, params ScanNewParams, opts ...option.RequestOption) (res *ScanNewResponse, err error)
Creates and starts a new vulnerability scan. The response may include non-fatal warnings in the `messages` array.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
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 TargetEnvironmentDeleteResponse ¶
type TargetEnvironmentDeleteResponse = interface{}
type TargetEnvironmentDeleteResponseEnvelope ¶
type TargetEnvironmentDeleteResponseEnvelope struct {
Errors []TargetEnvironmentDeleteResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []TargetEnvironmentDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success TargetEnvironmentDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
Result TargetEnvironmentDeleteResponse `json:"result" api:"nullable"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON targetEnvironmentDeleteResponseEnvelopeJSON `json:"-"`
}
Standard response envelope with a `null` result. Operations that produce no result body return this response.
func (*TargetEnvironmentDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *TargetEnvironmentDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentDeleteResponseEnvelopeErrors ¶
type TargetEnvironmentDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TargetEnvironmentDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON targetEnvironmentDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*TargetEnvironmentDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *TargetEnvironmentDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentDeleteResponseEnvelopeErrorsSource ¶
type TargetEnvironmentDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON targetEnvironmentDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*TargetEnvironmentDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *TargetEnvironmentDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentDeleteResponseEnvelopeMessages ¶
type TargetEnvironmentDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TargetEnvironmentDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON targetEnvironmentDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*TargetEnvironmentDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *TargetEnvironmentDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentDeleteResponseEnvelopeMessagesSource ¶
type TargetEnvironmentDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON targetEnvironmentDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*TargetEnvironmentDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *TargetEnvironmentDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentDeleteResponseEnvelopeSuccess ¶
type TargetEnvironmentDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
TargetEnvironmentDeleteResponseEnvelopeSuccessTrue TargetEnvironmentDeleteResponseEnvelopeSuccess = true
)
func (TargetEnvironmentDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r TargetEnvironmentDeleteResponseEnvelopeSuccess) IsKnown() bool
type TargetEnvironmentEditParams ¶
type TargetEnvironmentEditParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Optional description. Omit to leave unchanged, set to `null` to clear, or
// provide a string to update.
Description param.Field[string] `json:"description"`
// Human-readable name.
Name param.Field[string] `json:"name"`
// Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently
// the service supports only `zone` targets.
Target param.Field[TargetEnvironmentEditParamsTarget] `json:"target"`
}
func (TargetEnvironmentEditParams) MarshalJSON ¶
func (r TargetEnvironmentEditParams) MarshalJSON() (data []byte, err error)
type TargetEnvironmentEditParamsTarget ¶
type TargetEnvironmentEditParamsTarget struct {
Type param.Field[TargetEnvironmentEditParamsTargetType] `json:"type" api:"required"`
// Cloudflare zone tag. The zone must belong to the account.
ZoneTag param.Field[string] `json:"zone_tag" api:"required"`
}
Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently the service supports only `zone` targets.
func (TargetEnvironmentEditParamsTarget) MarshalJSON ¶
func (r TargetEnvironmentEditParamsTarget) MarshalJSON() (data []byte, err error)
type TargetEnvironmentEditParamsTargetType ¶
type TargetEnvironmentEditParamsTargetType string
const (
TargetEnvironmentEditParamsTargetTypeZone TargetEnvironmentEditParamsTargetType = "zone"
)
func (TargetEnvironmentEditParamsTargetType) IsKnown ¶
func (r TargetEnvironmentEditParamsTargetType) IsKnown() bool
type TargetEnvironmentEditResponse ¶
type TargetEnvironmentEditResponse struct {
// Target environment identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Human-readable name.
Name string `json:"name" api:"required"`
// Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently
// the service supports only `zone` targets.
Target TargetEnvironmentEditResponseTarget `json:"target" api:"required"`
// Optional description providing additional context.
Description string `json:"description" api:"nullable"`
JSON targetEnvironmentEditResponseJSON `json:"-"`
}
func (*TargetEnvironmentEditResponse) UnmarshalJSON ¶
func (r *TargetEnvironmentEditResponse) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentEditResponseEnvelope ¶
type TargetEnvironmentEditResponseEnvelope struct {
Errors []TargetEnvironmentEditResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []TargetEnvironmentEditResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success TargetEnvironmentEditResponseEnvelopeSuccess `json:"success" api:"required"`
Result TargetEnvironmentEditResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON targetEnvironmentEditResponseEnvelopeJSON `json:"-"`
}
func (*TargetEnvironmentEditResponseEnvelope) UnmarshalJSON ¶
func (r *TargetEnvironmentEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentEditResponseEnvelopeErrors ¶
type TargetEnvironmentEditResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TargetEnvironmentEditResponseEnvelopeErrorsSource `json:"source"`
JSON targetEnvironmentEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*TargetEnvironmentEditResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *TargetEnvironmentEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentEditResponseEnvelopeErrorsSource ¶
type TargetEnvironmentEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON targetEnvironmentEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*TargetEnvironmentEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *TargetEnvironmentEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentEditResponseEnvelopeMessages ¶
type TargetEnvironmentEditResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TargetEnvironmentEditResponseEnvelopeMessagesSource `json:"source"`
JSON targetEnvironmentEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*TargetEnvironmentEditResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *TargetEnvironmentEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentEditResponseEnvelopeMessagesSource ¶
type TargetEnvironmentEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON targetEnvironmentEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*TargetEnvironmentEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *TargetEnvironmentEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentEditResponseEnvelopeSuccess ¶
type TargetEnvironmentEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
TargetEnvironmentEditResponseEnvelopeSuccessTrue TargetEnvironmentEditResponseEnvelopeSuccess = true
)
func (TargetEnvironmentEditResponseEnvelopeSuccess) IsKnown ¶
func (r TargetEnvironmentEditResponseEnvelopeSuccess) IsKnown() bool
type TargetEnvironmentEditResponseTarget ¶
type TargetEnvironmentEditResponseTarget struct {
Type TargetEnvironmentEditResponseTargetType `json:"type" api:"required"`
// Cloudflare zone tag. The zone must belong to the account.
ZoneTag string `json:"zone_tag" api:"required"`
JSON targetEnvironmentEditResponseTargetJSON `json:"-"`
}
Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently the service supports only `zone` targets.
func (*TargetEnvironmentEditResponseTarget) UnmarshalJSON ¶
func (r *TargetEnvironmentEditResponseTarget) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentEditResponseTargetType ¶
type TargetEnvironmentEditResponseTargetType string
const (
TargetEnvironmentEditResponseTargetTypeZone TargetEnvironmentEditResponseTargetType = "zone"
)
func (TargetEnvironmentEditResponseTargetType) IsKnown ¶
func (r TargetEnvironmentEditResponseTargetType) IsKnown() bool
type TargetEnvironmentGetResponse ¶
type TargetEnvironmentGetResponse struct {
// Target environment identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Human-readable name.
Name string `json:"name" api:"required"`
// Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently
// the service supports only `zone` targets.
Target TargetEnvironmentGetResponseTarget `json:"target" api:"required"`
// Optional description providing additional context.
Description string `json:"description" api:"nullable"`
JSON targetEnvironmentGetResponseJSON `json:"-"`
}
func (*TargetEnvironmentGetResponse) UnmarshalJSON ¶
func (r *TargetEnvironmentGetResponse) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentGetResponseEnvelope ¶
type TargetEnvironmentGetResponseEnvelope struct {
Errors []TargetEnvironmentGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []TargetEnvironmentGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success TargetEnvironmentGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result TargetEnvironmentGetResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON targetEnvironmentGetResponseEnvelopeJSON `json:"-"`
}
func (*TargetEnvironmentGetResponseEnvelope) UnmarshalJSON ¶
func (r *TargetEnvironmentGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentGetResponseEnvelopeErrors ¶
type TargetEnvironmentGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TargetEnvironmentGetResponseEnvelopeErrorsSource `json:"source"`
JSON targetEnvironmentGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*TargetEnvironmentGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *TargetEnvironmentGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentGetResponseEnvelopeErrorsSource ¶
type TargetEnvironmentGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON targetEnvironmentGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*TargetEnvironmentGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *TargetEnvironmentGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentGetResponseEnvelopeMessages ¶
type TargetEnvironmentGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TargetEnvironmentGetResponseEnvelopeMessagesSource `json:"source"`
JSON targetEnvironmentGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*TargetEnvironmentGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *TargetEnvironmentGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentGetResponseEnvelopeMessagesSource ¶
type TargetEnvironmentGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON targetEnvironmentGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*TargetEnvironmentGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *TargetEnvironmentGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentGetResponseEnvelopeSuccess ¶
type TargetEnvironmentGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
TargetEnvironmentGetResponseEnvelopeSuccessTrue TargetEnvironmentGetResponseEnvelopeSuccess = true
)
func (TargetEnvironmentGetResponseEnvelopeSuccess) IsKnown ¶
func (r TargetEnvironmentGetResponseEnvelopeSuccess) IsKnown() bool
type TargetEnvironmentGetResponseTarget ¶
type TargetEnvironmentGetResponseTarget struct {
Type TargetEnvironmentGetResponseTargetType `json:"type" api:"required"`
// Cloudflare zone tag. The zone must belong to the account.
ZoneTag string `json:"zone_tag" api:"required"`
JSON targetEnvironmentGetResponseTargetJSON `json:"-"`
}
Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently the service supports only `zone` targets.
func (*TargetEnvironmentGetResponseTarget) UnmarshalJSON ¶
func (r *TargetEnvironmentGetResponseTarget) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentGetResponseTargetType ¶
type TargetEnvironmentGetResponseTargetType string
const (
TargetEnvironmentGetResponseTargetTypeZone TargetEnvironmentGetResponseTargetType = "zone"
)
func (TargetEnvironmentGetResponseTargetType) IsKnown ¶
func (r TargetEnvironmentGetResponseTargetType) IsKnown() bool
type TargetEnvironmentListParams ¶
type TargetEnvironmentListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Page number of paginated results.
Page param.Field[int64] `query:"page"`
// Number of results per page.
PerPage param.Field[int64] `query:"per_page"`
}
func (TargetEnvironmentListParams) URLQuery ¶
func (r TargetEnvironmentListParams) URLQuery() (v url.Values)
URLQuery serializes TargetEnvironmentListParams's query parameters as `url.Values`.
type TargetEnvironmentListResponse ¶
type TargetEnvironmentListResponse struct {
// Target environment identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Human-readable name.
Name string `json:"name" api:"required"`
// Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently
// the service supports only `zone` targets.
Target TargetEnvironmentListResponseTarget `json:"target" api:"required"`
// Optional description providing additional context.
Description string `json:"description" api:"nullable"`
JSON targetEnvironmentListResponseJSON `json:"-"`
}
func (*TargetEnvironmentListResponse) UnmarshalJSON ¶
func (r *TargetEnvironmentListResponse) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentListResponseTarget ¶
type TargetEnvironmentListResponseTarget struct {
Type TargetEnvironmentListResponseTargetType `json:"type" api:"required"`
// Cloudflare zone tag. The zone must belong to the account.
ZoneTag string `json:"zone_tag" api:"required"`
JSON targetEnvironmentListResponseTargetJSON `json:"-"`
}
Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently the service supports only `zone` targets.
func (*TargetEnvironmentListResponseTarget) UnmarshalJSON ¶
func (r *TargetEnvironmentListResponseTarget) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentListResponseTargetType ¶
type TargetEnvironmentListResponseTargetType string
const (
TargetEnvironmentListResponseTargetTypeZone TargetEnvironmentListResponseTargetType = "zone"
)
func (TargetEnvironmentListResponseTargetType) IsKnown ¶
func (r TargetEnvironmentListResponseTargetType) IsKnown() bool
type TargetEnvironmentNewParams ¶
type TargetEnvironmentNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Human-readable name.
Name param.Field[string] `json:"name" api:"required"`
// Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently
// the service supports only `zone` targets.
Target param.Field[TargetEnvironmentNewParamsTarget] `json:"target" api:"required"`
// Optional description.
Description param.Field[string] `json:"description"`
}
func (TargetEnvironmentNewParams) MarshalJSON ¶
func (r TargetEnvironmentNewParams) MarshalJSON() (data []byte, err error)
type TargetEnvironmentNewParamsTarget ¶
type TargetEnvironmentNewParamsTarget struct {
Type param.Field[TargetEnvironmentNewParamsTargetType] `json:"type" api:"required"`
// Cloudflare zone tag. The zone must belong to the account.
ZoneTag param.Field[string] `json:"zone_tag" api:"required"`
}
Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently the service supports only `zone` targets.
func (TargetEnvironmentNewParamsTarget) MarshalJSON ¶
func (r TargetEnvironmentNewParamsTarget) MarshalJSON() (data []byte, err error)
type TargetEnvironmentNewParamsTargetType ¶
type TargetEnvironmentNewParamsTargetType string
const (
TargetEnvironmentNewParamsTargetTypeZone TargetEnvironmentNewParamsTargetType = "zone"
)
func (TargetEnvironmentNewParamsTargetType) IsKnown ¶
func (r TargetEnvironmentNewParamsTargetType) IsKnown() bool
type TargetEnvironmentNewResponse ¶
type TargetEnvironmentNewResponse struct {
// Target environment identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Human-readable name.
Name string `json:"name" api:"required"`
// Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently
// the service supports only `zone` targets.
Target TargetEnvironmentNewResponseTarget `json:"target" api:"required"`
// Optional description providing additional context.
Description string `json:"description" api:"nullable"`
JSON targetEnvironmentNewResponseJSON `json:"-"`
}
func (*TargetEnvironmentNewResponse) UnmarshalJSON ¶
func (r *TargetEnvironmentNewResponse) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentNewResponseEnvelope ¶
type TargetEnvironmentNewResponseEnvelope struct {
Errors []TargetEnvironmentNewResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []TargetEnvironmentNewResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success TargetEnvironmentNewResponseEnvelopeSuccess `json:"success" api:"required"`
Result TargetEnvironmentNewResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON targetEnvironmentNewResponseEnvelopeJSON `json:"-"`
}
func (*TargetEnvironmentNewResponseEnvelope) UnmarshalJSON ¶
func (r *TargetEnvironmentNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentNewResponseEnvelopeErrors ¶
type TargetEnvironmentNewResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TargetEnvironmentNewResponseEnvelopeErrorsSource `json:"source"`
JSON targetEnvironmentNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*TargetEnvironmentNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *TargetEnvironmentNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentNewResponseEnvelopeErrorsSource ¶
type TargetEnvironmentNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON targetEnvironmentNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*TargetEnvironmentNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *TargetEnvironmentNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentNewResponseEnvelopeMessages ¶
type TargetEnvironmentNewResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TargetEnvironmentNewResponseEnvelopeMessagesSource `json:"source"`
JSON targetEnvironmentNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*TargetEnvironmentNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *TargetEnvironmentNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentNewResponseEnvelopeMessagesSource ¶
type TargetEnvironmentNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON targetEnvironmentNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*TargetEnvironmentNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *TargetEnvironmentNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentNewResponseEnvelopeSuccess ¶
type TargetEnvironmentNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
TargetEnvironmentNewResponseEnvelopeSuccessTrue TargetEnvironmentNewResponseEnvelopeSuccess = true
)
func (TargetEnvironmentNewResponseEnvelopeSuccess) IsKnown ¶
func (r TargetEnvironmentNewResponseEnvelopeSuccess) IsKnown() bool
type TargetEnvironmentNewResponseTarget ¶
type TargetEnvironmentNewResponseTarget struct {
Type TargetEnvironmentNewResponseTargetType `json:"type" api:"required"`
// Cloudflare zone tag. The zone must belong to the account.
ZoneTag string `json:"zone_tag" api:"required"`
JSON targetEnvironmentNewResponseTargetJSON `json:"-"`
}
Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently the service supports only `zone` targets.
func (*TargetEnvironmentNewResponseTarget) UnmarshalJSON ¶
func (r *TargetEnvironmentNewResponseTarget) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentNewResponseTargetType ¶
type TargetEnvironmentNewResponseTargetType string
const (
TargetEnvironmentNewResponseTargetTypeZone TargetEnvironmentNewResponseTargetType = "zone"
)
func (TargetEnvironmentNewResponseTargetType) IsKnown ¶
func (r TargetEnvironmentNewResponseTargetType) IsKnown() bool
type TargetEnvironmentService ¶
type TargetEnvironmentService struct {
Options []option.RequestOption
}
TargetEnvironmentService 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 NewTargetEnvironmentService method instead.
func NewTargetEnvironmentService ¶
func NewTargetEnvironmentService(opts ...option.RequestOption) (r *TargetEnvironmentService)
NewTargetEnvironmentService 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 (*TargetEnvironmentService) Delete ¶
func (r *TargetEnvironmentService) Delete(ctx context.Context, targetEnvironmentID string, body TargetEnvironmentDeleteParams, opts ...option.RequestOption) (res *TargetEnvironmentDeleteResponse, err error)
Removes a target environment.
func (*TargetEnvironmentService) Edit ¶
func (r *TargetEnvironmentService) Edit(ctx context.Context, targetEnvironmentID string, params TargetEnvironmentEditParams, opts ...option.RequestOption) (res *TargetEnvironmentEditResponse, err error)
Updates a target environment with only the provided fields; omitted fields remain unchanged.
func (*TargetEnvironmentService) Get ¶
func (r *TargetEnvironmentService) Get(ctx context.Context, targetEnvironmentID string, query TargetEnvironmentGetParams, opts ...option.RequestOption) (res *TargetEnvironmentGetResponse, err error)
Returns a single target environment by ID.
func (*TargetEnvironmentService) List ¶
func (r *TargetEnvironmentService) List(ctx context.Context, params TargetEnvironmentListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[TargetEnvironmentListResponse], err error)
Returns all target environments for the account.
func (*TargetEnvironmentService) ListAutoPaging ¶
func (r *TargetEnvironmentService) ListAutoPaging(ctx context.Context, params TargetEnvironmentListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[TargetEnvironmentListResponse]
Returns all target environments for the account.
func (*TargetEnvironmentService) New ¶
func (r *TargetEnvironmentService) New(ctx context.Context, params TargetEnvironmentNewParams, opts ...option.RequestOption) (res *TargetEnvironmentNewResponse, err error)
Creates a new target environment for the account.
func (*TargetEnvironmentService) Update ¶
func (r *TargetEnvironmentService) Update(ctx context.Context, targetEnvironmentID string, params TargetEnvironmentUpdateParams, opts ...option.RequestOption) (res *TargetEnvironmentUpdateResponse, err error)
Replaces a target environment. All fields must be provided.
type TargetEnvironmentUpdateParams ¶
type TargetEnvironmentUpdateParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Human-readable name.
Name param.Field[string] `json:"name" api:"required"`
// Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently
// the service supports only `zone` targets.
Target param.Field[TargetEnvironmentUpdateParamsTarget] `json:"target" api:"required"`
// Optional description.
Description param.Field[string] `json:"description"`
}
func (TargetEnvironmentUpdateParams) MarshalJSON ¶
func (r TargetEnvironmentUpdateParams) MarshalJSON() (data []byte, err error)
type TargetEnvironmentUpdateParamsTarget ¶
type TargetEnvironmentUpdateParamsTarget struct {
Type param.Field[TargetEnvironmentUpdateParamsTargetType] `json:"type" api:"required"`
// Cloudflare zone tag. The zone must belong to the account.
ZoneTag param.Field[string] `json:"zone_tag" api:"required"`
}
Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently the service supports only `zone` targets.
func (TargetEnvironmentUpdateParamsTarget) MarshalJSON ¶
func (r TargetEnvironmentUpdateParamsTarget) MarshalJSON() (data []byte, err error)
type TargetEnvironmentUpdateParamsTargetType ¶
type TargetEnvironmentUpdateParamsTargetType string
const (
TargetEnvironmentUpdateParamsTargetTypeZone TargetEnvironmentUpdateParamsTargetType = "zone"
)
func (TargetEnvironmentUpdateParamsTargetType) IsKnown ¶
func (r TargetEnvironmentUpdateParamsTargetType) IsKnown() bool
type TargetEnvironmentUpdateResponse ¶
type TargetEnvironmentUpdateResponse struct {
// Target environment identifier.
ID string `json:"id" api:"required" format:"uuid"`
// Human-readable name.
Name string `json:"name" api:"required"`
// Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently
// the service supports only `zone` targets.
Target TargetEnvironmentUpdateResponseTarget `json:"target" api:"required"`
// Optional description providing additional context.
Description string `json:"description" api:"nullable"`
JSON targetEnvironmentUpdateResponseJSON `json:"-"`
}
func (*TargetEnvironmentUpdateResponse) UnmarshalJSON ¶
func (r *TargetEnvironmentUpdateResponse) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentUpdateResponseEnvelope ¶
type TargetEnvironmentUpdateResponseEnvelope struct {
Errors []TargetEnvironmentUpdateResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []TargetEnvironmentUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success TargetEnvironmentUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
Result TargetEnvironmentUpdateResponse `json:"result"`
ResultInfo interface{} `json:"result_info" api:"nullable"`
JSON targetEnvironmentUpdateResponseEnvelopeJSON `json:"-"`
}
func (*TargetEnvironmentUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *TargetEnvironmentUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentUpdateResponseEnvelopeErrors ¶
type TargetEnvironmentUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TargetEnvironmentUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON targetEnvironmentUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*TargetEnvironmentUpdateResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *TargetEnvironmentUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentUpdateResponseEnvelopeErrorsSource ¶
type TargetEnvironmentUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON targetEnvironmentUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*TargetEnvironmentUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *TargetEnvironmentUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentUpdateResponseEnvelopeMessages ¶
type TargetEnvironmentUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TargetEnvironmentUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON targetEnvironmentUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*TargetEnvironmentUpdateResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *TargetEnvironmentUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentUpdateResponseEnvelopeMessagesSource ¶
type TargetEnvironmentUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON targetEnvironmentUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*TargetEnvironmentUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *TargetEnvironmentUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentUpdateResponseEnvelopeSuccess ¶
type TargetEnvironmentUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
TargetEnvironmentUpdateResponseEnvelopeSuccessTrue TargetEnvironmentUpdateResponseEnvelopeSuccess = true
)
func (TargetEnvironmentUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r TargetEnvironmentUpdateResponseEnvelopeSuccess) IsKnown() bool
type TargetEnvironmentUpdateResponseTarget ¶
type TargetEnvironmentUpdateResponseTarget struct {
Type TargetEnvironmentUpdateResponseTargetType `json:"type" api:"required"`
// Cloudflare zone tag. The zone must belong to the account.
ZoneTag string `json:"zone_tag" api:"required"`
JSON targetEnvironmentUpdateResponseTargetJSON `json:"-"`
}
Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently the service supports only `zone` targets.
func (*TargetEnvironmentUpdateResponseTarget) UnmarshalJSON ¶
func (r *TargetEnvironmentUpdateResponseTarget) UnmarshalJSON(data []byte) (err error)
type TargetEnvironmentUpdateResponseTargetType ¶
type TargetEnvironmentUpdateResponseTargetType string
const (
TargetEnvironmentUpdateResponseTargetTypeZone TargetEnvironmentUpdateResponseTargetType = "zone"
)
func (TargetEnvironmentUpdateResponseTargetType) IsKnown ¶
func (r TargetEnvironmentUpdateResponseTargetType) IsKnown() bool
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 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.
type VulnerabilityScannerService ¶
type VulnerabilityScannerService struct {
Options []option.RequestOption
CredentialSets *CredentialSetService
Scans *ScanService
TargetEnvironments *TargetEnvironmentService
}
VulnerabilityScannerService 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 NewVulnerabilityScannerService method instead.
func NewVulnerabilityScannerService ¶
func NewVulnerabilityScannerService(opts ...option.RequestOption) (r *VulnerabilityScannerService)
NewVulnerabilityScannerService 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.