Documentation
¶
Index ¶
- type ActiveSuppressCount
- type ComplianceStatus
- type DeletePolicy
- type DeleteResource
- type DeleteStatus
- type DeleteStatusBatch
- type EntireOrg
- type Error
- type ErrorMessage
- type ExpiresAt
- type IgnoreSet
- type IntegrationID
- type ItemSummary
- type LastUpdated
- type OrgSummary
- type Paging
- type PolicyID
- type PolicyResourceDetail
- type PolicySeverity
- type PolicySummary
- type ResourceID
- type ResourceOfType
- type ResourceSummary
- type ResourceType
- type ScannedResources
- type SetStatus
- type SetStatusBatch
- type Status
- type StatusCount
- type StatusCountBySeverity
- type Suppressed
- type UpdateMetadata
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActiveSuppressCount ¶
type ActiveSuppressCount struct {
// active
// Required: true
Active *StatusCount `json:"active"`
// suppressed
// Required: true
Suppressed *StatusCount `json:"suppressed"`
}
ActiveSuppressCount active suppress count
swagger:model ActiveSuppressCount
func (*ActiveSuppressCount) MarshalBinary ¶
func (m *ActiveSuppressCount) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ActiveSuppressCount) UnmarshalBinary ¶
func (m *ActiveSuppressCount) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ComplianceStatus ¶
type ComplianceStatus struct {
// error message
ErrorMessage ErrorMessage `json:"errorMessage,omitempty"`
// expires at
// Required: true
ExpiresAt ExpiresAt `json:"expiresAt"`
// integration Id
// Required: true
IntegrationID IntegrationID `json:"integrationId"`
// last updated
// Required: true
// Format: date-time
LastUpdated LastUpdated `json:"lastUpdated"`
// policy Id
// Required: true
PolicyID PolicyID `json:"policyId"`
// policy severity
// Required: true
PolicySeverity PolicySeverity `json:"policySeverity"`
// resource Id
// Required: true
ResourceID ResourceID `json:"resourceId"`
// resource type
// Required: true
ResourceType ResourceType `json:"resourceType"`
// status
// Required: true
Status Status `json:"status"`
// suppressed
// Required: true
Suppressed Suppressed `json:"suppressed"`
}
ComplianceStatus compliance status
swagger:model ComplianceStatus
func (*ComplianceStatus) MarshalBinary ¶
func (m *ComplianceStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ComplianceStatus) UnmarshalBinary ¶
func (m *ComplianceStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeletePolicy ¶
type DeletePolicy struct {
// id
// Required: true
ID PolicyID `json:"id"`
// Only delete entries with these specific resource types
ResourceTypes []string `json:"resourceTypes"`
}
DeletePolicy delete policy
swagger:model DeletePolicy
func (*DeletePolicy) MarshalBinary ¶
func (m *DeletePolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeletePolicy) UnmarshalBinary ¶
func (m *DeletePolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeleteResource ¶
type DeleteResource struct {
// id
// Required: true
ID ResourceID `json:"id"`
}
DeleteResource delete resource
swagger:model DeleteResource
func (*DeleteResource) MarshalBinary ¶
func (m *DeleteResource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteResource) UnmarshalBinary ¶
func (m *DeleteResource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeleteStatus ¶
type DeleteStatus struct {
// policy
Policy *DeletePolicy `json:"policy,omitempty"`
// resource
Resource *DeleteResource `json:"resource,omitempty"`
}
DeleteStatus delete status
swagger:model DeleteStatus
func (*DeleteStatus) MarshalBinary ¶
func (m *DeleteStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteStatus) UnmarshalBinary ¶
func (m *DeleteStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeleteStatusBatch ¶
type DeleteStatusBatch struct {
// entries
// Required: true
// Min Items: 1
Entries []*DeleteStatus `json:"entries"`
}
DeleteStatusBatch delete status batch
swagger:model DeleteStatusBatch
func (*DeleteStatusBatch) MarshalBinary ¶
func (m *DeleteStatusBatch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteStatusBatch) UnmarshalBinary ¶
func (m *DeleteStatusBatch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EntireOrg ¶
type EntireOrg struct {
// policies
// Required: true
Policies []*ItemSummary `json:"policies"`
// resources
// Required: true
Resources []*ItemSummary `json:"resources"`
}
EntireOrg entire org
swagger:model EntireOrg
func (*EntireOrg) MarshalBinary ¶
MarshalBinary interface implementation
func (*EntireOrg) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// Error message
// Required: true
Message *string `json:"message"`
}
Error error
swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ErrorMessage ¶
type ErrorMessage string
ErrorMessage Error message when policy was applied to this resource
swagger:model errorMessage
type ExpiresAt ¶
type ExpiresAt int64
ExpiresAt Dynamo TTL - unix time when the status will be automatically cleared
swagger:model expiresAt
type IgnoreSet ¶
type IgnoreSet []string
IgnoreSet Resource glob patterns which should be suppressed
swagger:model IgnoreSet
type IntegrationID ¶
type IntegrationID string
IntegrationID IntegrationID where the resource was discovered
swagger:model integrationId
type ItemSummary ¶
type ItemSummary struct {
// id
// Required: true
ID *string `json:"id"`
// status
// Required: true
Status Status `json:"status"`
}
ItemSummary Summary of a single policy or resource compliance status
swagger:model ItemSummary
func (*ItemSummary) MarshalBinary ¶
func (m *ItemSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ItemSummary) UnmarshalBinary ¶
func (m *ItemSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LastUpdated ¶
LastUpdated When the compliance state was last updated in the Panther database
swagger:model lastUpdated
func (*LastUpdated) MarshalBinary ¶
func (m *LastUpdated) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (LastUpdated) MarshalJSON ¶
func (m LastUpdated) MarshalJSON() ([]byte, error)
MarshalJSON retrieves a LastUpdated value as JSON output
func (*LastUpdated) UnmarshalBinary ¶
func (m *LastUpdated) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*LastUpdated) UnmarshalJSON ¶
func (m *LastUpdated) UnmarshalJSON(b []byte) error
UnmarshalJSON sets a LastUpdated value from JSON input
type OrgSummary ¶
type OrgSummary struct {
// applied policies
// Required: true
AppliedPolicies *StatusCountBySeverity `json:"appliedPolicies"`
// scanned resources
// Required: true
ScannedResources *ScannedResources `json:"scannedResources"`
// top failing policies
// Required: true
TopFailingPolicies []*PolicySummary `json:"topFailingPolicies"`
// top failing resources
// Required: true
TopFailingResources []*ResourceSummary `json:"topFailingResources"`
}
OrgSummary org summary
swagger:model OrgSummary
func (*OrgSummary) MarshalBinary ¶
func (m *OrgSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrgSummary) UnmarshalBinary ¶
func (m *OrgSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Paging ¶
type Paging struct {
// this page
// Required: true
// Minimum: 1
ThisPage *int64 `json:"thisPage"`
// total items
// Required: true
// Minimum: 1
TotalItems *int64 `json:"totalItems"`
// total pages
// Required: true
// Minimum: 1
TotalPages *int64 `json:"totalPages"`
}
Paging paging
swagger:model Paging
func (*Paging) MarshalBinary ¶
MarshalBinary interface implementation
func (*Paging) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PolicyID ¶
type PolicyID string
PolicyID Panther policy ID, unique within each customer's account
swagger:model policyId
type PolicyResourceDetail ¶
type PolicyResourceDetail struct {
// items
// Required: true
Items []*ComplianceStatus `json:"items"`
// paging
// Required: true
Paging *Paging `json:"paging"`
// status
// Required: true
Status Status `json:"status"`
// totals
// Required: true
Totals *ActiveSuppressCount `json:"totals"`
}
PolicyResourceDetail policy resource detail
swagger:model PolicyResourceDetail
func (*PolicyResourceDetail) MarshalBinary ¶
func (m *PolicyResourceDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PolicyResourceDetail) UnmarshalBinary ¶
func (m *PolicyResourceDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PolicySeverity ¶
type PolicySeverity string
PolicySeverity Policy severity
swagger:model policySeverity
const ( // PolicySeverityINFO captures enum value "INFO" PolicySeverityINFO PolicySeverity = "INFO" // PolicySeverityLOW captures enum value "LOW" PolicySeverityLOW PolicySeverity = "LOW" // PolicySeverityMEDIUM captures enum value "MEDIUM" PolicySeverityMEDIUM PolicySeverity = "MEDIUM" // PolicySeverityHIGH captures enum value "HIGH" PolicySeverityHIGH PolicySeverity = "HIGH" // PolicySeverityCRITICAL captures enum value "CRITICAL" PolicySeverityCRITICAL PolicySeverity = "CRITICAL" )
type PolicySummary ¶
type PolicySummary struct {
// count
// Required: true
Count *StatusCount `json:"count"`
// id
// Required: true
ID PolicyID `json:"id"`
// severity
// Required: true
Severity PolicySeverity `json:"severity"`
}
PolicySummary Summary of a single policy compliance status
swagger:model PolicySummary
func (*PolicySummary) MarshalBinary ¶
func (m *PolicySummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PolicySummary) UnmarshalBinary ¶
func (m *PolicySummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResourceID ¶
type ResourceID string
ResourceID Globally unique resource ID
swagger:model resourceId
type ResourceOfType ¶
type ResourceOfType struct {
// count
// Required: true
Count *StatusCount `json:"count"`
// type
// Required: true
Type ResourceType `json:"type"`
}
ResourceOfType resource of type
swagger:model ResourceOfType
func (*ResourceOfType) MarshalBinary ¶
func (m *ResourceOfType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourceOfType) UnmarshalBinary ¶
func (m *ResourceOfType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResourceSummary ¶
type ResourceSummary struct {
// count
// Required: true
Count *StatusCountBySeverity `json:"count"`
// id
// Required: true
ID ResourceID `json:"id"`
// type
// Required: true
Type ResourceType `json:"type"`
}
ResourceSummary Summary of a single resource compliance status
swagger:model ResourceSummary
func (*ResourceSummary) MarshalBinary ¶
func (m *ResourceSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourceSummary) UnmarshalBinary ¶
func (m *ResourceSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ScannedResources ¶
type ScannedResources struct {
// by type
// Required: true
ByType []*ResourceOfType `json:"byType"`
}
ScannedResources scanned resources
swagger:model ScannedResources
func (*ScannedResources) MarshalBinary ¶
func (m *ScannedResources) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ScannedResources) UnmarshalBinary ¶
func (m *ScannedResources) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SetStatus ¶
type SetStatus struct {
// error message
ErrorMessage ErrorMessage `json:"errorMessage,omitempty"`
// integration Id
// Required: true
IntegrationID IntegrationID `json:"integrationId"`
// policy Id
// Required: true
PolicyID PolicyID `json:"policyId"`
// policy severity
// Required: true
PolicySeverity PolicySeverity `json:"policySeverity"`
// resource Id
// Required: true
ResourceID ResourceID `json:"resourceId"`
// resource type
// Required: true
ResourceType ResourceType `json:"resourceType"`
// status
// Required: true
Status Status `json:"status"`
// suppressed
// Required: true
Suppressed Suppressed `json:"suppressed"`
}
SetStatus set status
swagger:model SetStatus
func (*SetStatus) MarshalBinary ¶
MarshalBinary interface implementation
func (*SetStatus) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SetStatusBatch ¶
type SetStatusBatch struct {
// entries
// Required: true
// Min Items: 1
Entries []*SetStatus `json:"entries"`
}
SetStatusBatch set status batch
swagger:model SetStatusBatch
func (*SetStatusBatch) MarshalBinary ¶
func (m *SetStatusBatch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SetStatusBatch) UnmarshalBinary ¶
func (m *SetStatusBatch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Status ¶
type Status string
Status Compliance status for one or more policy/resource pairs. A list has the collective status ERROR or FAIL if any of them individually error or fail.
swagger:model status
type StatusCount ¶
type StatusCount struct {
// error
// Minimum: 0
Error *int64 `json:"error,omitempty"`
// fail
// Minimum: 0
Fail *int64 `json:"fail,omitempty"`
// pass
// Minimum: 0
Pass *int64 `json:"pass,omitempty"`
}
StatusCount status count
swagger:model StatusCount
func (*StatusCount) MarshalBinary ¶
func (m *StatusCount) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StatusCount) UnmarshalBinary ¶
func (m *StatusCount) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StatusCountBySeverity ¶
type StatusCountBySeverity struct {
// critical
Critical *StatusCount `json:"critical,omitempty"`
// high
High *StatusCount `json:"high,omitempty"`
// info
Info *StatusCount `json:"info,omitempty"`
// low
Low *StatusCount `json:"low,omitempty"`
// medium
Medium *StatusCount `json:"medium,omitempty"`
}
StatusCountBySeverity status count by severity
swagger:model StatusCountBySeverity
func (*StatusCountBySeverity) MarshalBinary ¶
func (m *StatusCountBySeverity) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StatusCountBySeverity) UnmarshalBinary ¶
func (m *StatusCountBySeverity) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Suppressed ¶
type Suppressed bool
Suppressed True if this resource is ignored/suppressed by this specific policy. Suppressed resources are still analyzed and reported, but do not trigger alerts/remediations.
swagger:model suppressed
type UpdateMetadata ¶
type UpdateMetadata struct {
// policy Id
// Required: true
PolicyID PolicyID `json:"policyId"`
// severity
// Required: true
Severity PolicySeverity `json:"severity"`
// suppressions
Suppressions IgnoreSet `json:"suppressions,omitempty"`
}
UpdateMetadata update metadata
swagger:model UpdateMetadata
func (*UpdateMetadata) MarshalBinary ¶
func (m *UpdateMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateMetadata) UnmarshalBinary ¶
func (m *UpdateMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- active_suppress_count.go
- compliance_status.go
- delete_policy.go
- delete_resource.go
- delete_status.go
- delete_status_batch.go
- entire_org.go
- error.go
- error_message.go
- expires_at.go
- ignore_set.go
- integration_id.go
- item_summary.go
- last_updated.go
- org_summary.go
- paging.go
- policy_id.go
- policy_resource_detail.go
- policy_severity.go
- policy_summary.go
- resource_id.go
- resource_of_type.go
- resource_summary.go
- resource_type.go
- scanned_resources.go
- set_status.go
- set_status_batch.go
- status.go
- status_count.go
- status_count_by_severity.go
- suppressed.go
- update_metadata.go