posturemanagementv1

package
v3.1.6 Latest Latest
Warning

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

 Go to latest Published: Mar 9, 2022 License: Apache-2.0 Imports: 11 Imported by: 1

Documentation

Overview

Package posturemanagementv1 : Operations and models for the PostureManagementV1 service

Index

Constants

View Source 
const (
	ControlStatusPassConst            = "pass"
	ControlStatusUnableToPerformConst = "unable_to_perform"
)

Constants associated with the Control.Status property. The control status.

View Source 
const (
	CreateCollectorOptionsManagedByCustomerConst = "customer"
	CreateCollectorOptionsManagedByIBMConst      = "ibm"
)

Constants associated with the CreateCollectorOptions.ManagedBy property. Determines whether the collector is an IBM or customer-managed virtual machine. Use `ibm` to allow Security and Compliance Center to create, install, and manage the collector on your behalf. The collector is installed in an OpenShift cluster and approved automatically for use. Use `customer` if you would like to install the collector by using your own virtual machine. For more information, check out the [docs](https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-collector).

View Source 
const (
	CreateScopeOptionsEnvironmentTypeAwsConst       = "aws"
	CreateScopeOptionsEnvironmentTypeAzureConst     = "azure"
	CreateScopeOptionsEnvironmentTypeGcpConst       = "gcp"
	CreateScopeOptionsEnvironmentTypeHostedConst    = "hosted"
	CreateScopeOptionsEnvironmentTypeIBMConst       = "ibm"
	CreateScopeOptionsEnvironmentTypeOnPremiseConst = "on_premise"
	CreateScopeOptionsEnvironmentTypeOpenstackConst = "openstack"
	CreateScopeOptionsEnvironmentTypeServicesConst  = "services"
)

Constants associated with the CreateScopeOptions.EnvironmentType property. The environment that the scope is targeted to.

View Source 
const (
	GoalStatusFailConst = "fail"
	GoalStatusPassConst = "pass"
)

Constants associated with the Goal.Status property. The goal status.

View Source 
const (
	GroupProfileResultProfileTypeAuthoredConst            = "authored"
	GroupProfileResultProfileTypeCustomConst              = "custom"
	GroupProfileResultProfileTypeStandardConst            = "standard"
	GroupProfileResultProfileTypeStandardCertificateConst = "standard_certificate"
	GroupProfileResultProfileTypeStandardCvConst          = "standard_cv"
	GroupProfileResultProfileTypeTemmplategroupConst      = "temmplategroup"
)

Constants associated with the GroupProfileResult.ProfileType property. The type of profile. To learn more about profile types, check out the [docs] (https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-profiles).

View Source 
const (
	ProfileItemProfileTypeCustomConst        = "custom"
	ProfileItemProfileTypePredefinedConst    = "predefined"
	ProfileItemProfileTypeTemplateGroupConst = "template_group"
)

Constants associated with the ProfileItem.ProfileType property. The type of profile.

View Source 
const (
	ProfileResultProfileTypeAuthoredConst            = "authored"
	ProfileResultProfileTypeCustomConst              = "custom"
	ProfileResultProfileTypeStandardConst            = "standard"
	ProfileResultProfileTypeStandardCertificateConst = "standard_certificate"
	ProfileResultProfileTypeStandardCvConst          = "standard_cv"
	ProfileResultProfileTypeTemmplategroupConst      = "temmplategroup"
)

Constants associated with the ProfileResult.ProfileType property. The type of profile. To learn more about profile types, check out the [docs] (https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-profiles).

View Source 
const (
	ProfilesResultProfileTypeAuthoredConst            = "authored"
	ProfilesResultProfileTypeCustomConst              = "custom"
	ProfilesResultProfileTypeStandardConst            = "standard"
	ProfilesResultProfileTypeStandardCertificateConst = "standard_certificate"
	ProfilesResultProfileTypeStandardCvConst          = "standard_cv"
	ProfilesResultProfileTypeTemmplategroupConst      = "temmplategroup"
)

Constants associated with the ProfilesResult.ProfileType property. The type of profile. To learn more about profile types, check out the [docs] (https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-profiles).

View Source 
const (
	ResourceResultResourceStatusPassConst            = "pass"
	ResourceResultResourceStatusUnableToPerformConst = "unable_to_perform"
)

Constants associated with the ResourceResult.ResourceStatus property. The resource control result status.

View Source 
const (
	ScanStatusAbortTaskRequestCompletedConst       = "abort_task_request_completed"
	ScanStatusAbortTaskRequestFailedConst          = "abort_task_request_failed"
	ScanStatusAbortTaskRequestReceivedConst        = "abort_task_request_received"
	ScanStatusControllerAbortedConst               = "controller_aborted"
	ScanStatusDiscoveryCompletedConst              = "discovery_completed"
	ScanStatusDiscoveryInProgressConst             = "discovery_in_progress"
	ScanStatusDiscoveryResultPostedNoErrorConst    = "discovery_result_posted_no_error"
	ScanStatusDiscoveryResultPostedWithErrorConst  = "discovery_result_posted_with_error"
	ScanStatusDiscoveryStartedConst                = "discovery_started"
	ScanStatusErrorInAbortTaskRequestConst         = "error_in_abort_task_request"
	ScanStatusErrorInDiscoveryConst                = "error_in_discovery"
	ScanStatusErrorInFactCollectionConst           = "error_in_fact_collection"
	ScanStatusErrorInFactValidationConst           = "error_in_fact_validation"
	ScanStatusErrorInInventoryConst                = "error_in_inventory"
	ScanStatusErrorInRemediationConst              = "error_in_remediation"
	ScanStatusErrorInValidationConst               = "error_in_validation"
	ScanStatusFactCollectionCompletedConst         = "fact_collection_completed"
	ScanStatusFactCollectionInProgressConst        = "fact_collection_in_progress"
	ScanStatusFactCollectionStartedConst           = "fact_collection_started"
	ScanStatusFactValidationCompletedConst         = "fact_validation_completed"
	ScanStatusFactValidationInProgressConst        = "fact_validation_in_progress"
	ScanStatusFactValidationStartedConst           = "fact_validation_started"
	ScanStatusGatewayAbortedConst                  = "gateway_aborted"
	ScanStatusInventoryCompletedConst              = "inventory_completed"
	ScanStatusInventoryCompletedWithErrorConst     = "inventory_completed_with_error"
	ScanStatusInventoryInProgressConst             = "inventory_in_progress"
	ScanStatusInventoryStartedConst                = "inventory_started"
	ScanStatusNotAcceptedConst                     = "not_accepted"
	ScanStatusPendingConst                         = "pending"
	ScanStatusRemediationCompletedConst            = "remediation_completed"
	ScanStatusRemediationInProgressConst           = "remediation_in_progress"
	ScanStatusRemediationStartedConst              = "remediation_started"
	ScanStatusSentToCollectorConst                 = "sent_to_collector"
	ScanStatusUserAbortedConst                     = "user_aborted"
	ScanStatusValidationCompletedConst             = "validation_completed"
	ScanStatusValidationInProgressConst            = "validation_in_progress"
	ScanStatusValidationResultPostedNoErrorConst   = "validation_result_posted_no_error"
	ScanStatusValidationResultPostedWithErrorConst = "validation_result_posted_with_error"
	ScanStatusValidationStartedConst               = "validation_started"
	ScanStatusWaitingForRefineConst                = "waiting_for_refine"
)

Constants associated with the Scan.Status property. The status of the collector as it completes a scan.

View Source 
const (
	ScanItemProfileTypeAuthoredConst            = "authored"
	ScanItemProfileTypeCustomConst              = "custom"
	ScanItemProfileTypeStandardConst            = "standard"
	ScanItemProfileTypeStandardCertificateConst = "standard_certificate"
	ScanItemProfileTypeStandardCvConst          = "standard_cv"
	ScanItemProfileTypeTemmplategroupConst      = "temmplategroup"
)

Constants associated with the ScanItem.ProfileType property. The type of profile. To learn more about profile types, check out the [docs] (https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-profiles).

View Source 
const (
	ScopeEnvironmentTypeAwsConst       = "aws"
	ScopeEnvironmentTypeAzureConst     = "azure"
	ScopeEnvironmentTypeGcpConst       = "gcp"
	ScopeEnvironmentTypeHostedConst    = "hosted"
	ScopeEnvironmentTypeIBMConst       = "ibm"
	ScopeEnvironmentTypeOnPremiseConst = "on_premise"
	ScopeEnvironmentTypeOpenstackConst = "openstack"
	ScopeEnvironmentTypeServicesConst  = "services"
)

Constants associated with the Scope.EnvironmentType property. The environment that the scope is targeted to.

View Source 
const (
	ScopeItemEnvironmentTypeAwsConst       = "aws"
	ScopeItemEnvironmentTypeAzureConst     = "azure"
	ScopeItemEnvironmentTypeGcpConst       = "gcp"
	ScopeItemEnvironmentTypeHostedConst    = "hosted"
	ScopeItemEnvironmentTypeIBMConst       = "ibm"
	ScopeItemEnvironmentTypeOnPremiseConst = "on_premise"
	ScopeItemEnvironmentTypeOpenstackConst = "openstack"
	ScopeItemEnvironmentTypeServicesConst  = "services"
)

Constants associated with the ScopeItem.EnvironmentType property. The environment that the scope is targeted to.

View Source 
const (
	ScopeItemLastScanTypeAbortTasksConst     = "abort_tasks"
	ScopeItemLastScanTypeDiscoveryConst      = "discovery"
	ScopeItemLastScanTypeEvidenceConst       = "evidence"
	ScopeItemLastScanTypeFactCollectionConst = "fact_collection"
	ScopeItemLastScanTypeFactValidationConst = "fact_validation"
	ScopeItemLastScanTypeInventoryConst      = "inventory"
	ScopeItemLastScanTypeRemediationConst    = "remediation"
	ScopeItemLastScanTypeScriptConst         = "script"
	ScopeItemLastScanTypeValidationConst     = "validation"
)

Constants associated with the ScopeItem.LastScanType property. The last type of scan that was run on the scope.

View Source 
const (
	SummaryItemStatusAbortTaskRequestCompletedConst       = "abort_task_request_completed"
	SummaryItemStatusAbortTaskRequestFailedConst          = "abort_task_request_failed"
	SummaryItemStatusAbortTaskRequestReceivedConst        = "abort_task_request_received"
	SummaryItemStatusControllerAbortedConst               = "controller_aborted"
	SummaryItemStatusDiscoveryCompletedConst              = "discovery_completed"
	SummaryItemStatusDiscoveryInProgressConst             = "discovery_in_progress"
	SummaryItemStatusDiscoveryResultPostedNoErrorConst    = "discovery_result_posted_no_error"
	SummaryItemStatusDiscoveryResultPostedWithErrorConst  = "discovery_result_posted_with_error"
	SummaryItemStatusDiscoveryStartedConst                = "discovery_started"
	SummaryItemStatusErrorInAbortTaskRequestConst         = "error_in_abort_task_request"
	SummaryItemStatusErrorInDiscoveryConst                = "error_in_discovery"
	SummaryItemStatusErrorInFactCollectionConst           = "error_in_fact_collection"
	SummaryItemStatusErrorInFactValidationConst           = "error_in_fact_validation"
	SummaryItemStatusErrorInInventoryConst                = "error_in_inventory"
	SummaryItemStatusErrorInRemediationConst              = "error_in_remediation"
	SummaryItemStatusErrorInValidationConst               = "error_in_validation"
	SummaryItemStatusFactCollectionCompletedConst         = "fact_collection_completed"
	SummaryItemStatusFactCollectionInProgressConst        = "fact_collection_in_progress"
	SummaryItemStatusFactCollectionStartedConst           = "fact_collection_started"
	SummaryItemStatusFactValidationCompletedConst         = "fact_validation_completed"
	SummaryItemStatusFactValidationInProgressConst        = "fact_validation_in_progress"
	SummaryItemStatusFactValidationStartedConst           = "fact_validation_started"
	SummaryItemStatusGatewayAbortedConst                  = "gateway_aborted"
	SummaryItemStatusInventoryCompletedConst              = "inventory_completed"
	SummaryItemStatusInventoryCompletedWithErrorConst     = "inventory_completed_with_error"
	SummaryItemStatusInventoryInProgressConst             = "inventory_in_progress"
	SummaryItemStatusInventoryStartedConst                = "inventory_started"
	SummaryItemStatusNotAcceptedConst                     = "not_accepted"
	SummaryItemStatusPendingConst                         = "pending"
	SummaryItemStatusRemediationCompletedConst            = "remediation_completed"
	SummaryItemStatusRemediationInProgressConst           = "remediation_in_progress"
	SummaryItemStatusRemediationStartedConst              = "remediation_started"
	SummaryItemStatusSentToCollectorConst                 = "sent_to_collector"
	SummaryItemStatusUserAbortedConst                     = "user_aborted"
	SummaryItemStatusValidationCompletedConst             = "validation_completed"
	SummaryItemStatusValidationInProgressConst            = "validation_in_progress"
	SummaryItemStatusValidationResultPostedNoErrorConst   = "validation_result_posted_no_error"
	SummaryItemStatusValidationResultPostedWithErrorConst = "validation_result_posted_with_error"
	SummaryItemStatusValidationStartedConst               = "validation_started"
	SummaryItemStatusWaitingForRefineConst                = "waiting_for_refine"
)

Constants associated with the SummaryItem.Status property. The status of the collector as it completes a scan.

View Source 
const DefaultServiceName = "posture_management"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://us.compliance.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

View Source 
const ParameterizedServiceURL = "https://{environment}.cloud.ibm.com"

Variables

This section is empty.

Functions

func ConstructServiceURL 

func ConstructServiceURL(providedUrlVariables map[string]string) (string, error)

ConstructServiceURL constructs a service URL from the parameterized URL.

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalApplicabilityCriteria 

func UnmarshalApplicabilityCriteria(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalApplicabilityCriteria unmarshals an instance of ApplicabilityCriteria from the specified map of raw messages.

func UnmarshalCollector 

func UnmarshalCollector(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCollector unmarshals an instance of Collector from the specified map of raw messages.

func UnmarshalControl 

func UnmarshalControl(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalControl unmarshals an instance of Control from the specified map of raw messages.

func UnmarshalCredential 

func UnmarshalCredential(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCredential unmarshals an instance of Credential from the specified map of raw messages.

func UnmarshalGoal 

func UnmarshalGoal(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGoal unmarshals an instance of Goal from the specified map of raw messages.

func UnmarshalGoalApplicabilityCriteria 

func UnmarshalGoalApplicabilityCriteria(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGoalApplicabilityCriteria unmarshals an instance of GoalApplicabilityCriteria from the specified map of raw messages.

func UnmarshalGroupProfileResult 

func UnmarshalGroupProfileResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupProfileResult unmarshals an instance of GroupProfileResult from the specified map of raw messages.

func UnmarshalProfileItem 

func UnmarshalProfileItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProfileItem unmarshals an instance of ProfileItem from the specified map of raw messages.

func UnmarshalProfileResult 

func UnmarshalProfileResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProfileResult unmarshals an instance of ProfileResult from the specified map of raw messages.

func UnmarshalProfilesList 

func UnmarshalProfilesList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProfilesList unmarshals an instance of ProfilesList from the specified map of raw messages.

func UnmarshalProfilesListFirst 

func UnmarshalProfilesListFirst(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProfilesListFirst unmarshals an instance of ProfilesListFirst from the specified map of raw messages.

func UnmarshalProfilesListLast 

func UnmarshalProfilesListLast(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProfilesListLast unmarshals an instance of ProfilesListLast from the specified map of raw messages.

func UnmarshalProfilesListNext 

func UnmarshalProfilesListNext(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProfilesListNext unmarshals an instance of ProfilesListNext from the specified map of raw messages.

func UnmarshalProfilesListPrevious 

func UnmarshalProfilesListPrevious(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProfilesListPrevious unmarshals an instance of ProfilesListPrevious from the specified map of raw messages.

func UnmarshalProfilesResult 

func UnmarshalProfilesResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProfilesResult unmarshals an instance of ProfilesResult from the specified map of raw messages.

func UnmarshalResourceResult 

func UnmarshalResourceResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceResult unmarshals an instance of ResourceResult from the specified map of raw messages.

func UnmarshalResourceStatistics 

func UnmarshalResourceStatistics(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceStatistics unmarshals an instance of ResourceStatistics from the specified map of raw messages.

func UnmarshalResult 

func UnmarshalResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResult unmarshals an instance of Result from the specified map of raw messages.

func UnmarshalResults 

func UnmarshalResults(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResults unmarshals an instance of Results from the specified map of raw messages.

func UnmarshalScan 

func UnmarshalScan(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScan unmarshals an instance of Scan from the specified map of raw messages.

func UnmarshalScanItem 

func UnmarshalScanItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScanItem unmarshals an instance of ScanItem from the specified map of raw messages.

func UnmarshalScanResult 

func UnmarshalScanResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScanResult unmarshals an instance of ScanResult from the specified map of raw messages.

func UnmarshalScansList 

func UnmarshalScansList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScansList unmarshals an instance of ScansList from the specified map of raw messages.

func UnmarshalScansListFirst 

func UnmarshalScansListFirst(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScansListFirst unmarshals an instance of ScansListFirst from the specified map of raw messages.

func UnmarshalScansListLast 

func UnmarshalScansListLast(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScansListLast unmarshals an instance of ScansListLast from the specified map of raw messages.

func UnmarshalScansListNext 

func UnmarshalScansListNext(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScansListNext unmarshals an instance of ScansListNext from the specified map of raw messages.

func UnmarshalScansListPrevious 

func UnmarshalScansListPrevious(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScansListPrevious unmarshals an instance of ScansListPrevious from the specified map of raw messages.

func UnmarshalScope 

func UnmarshalScope(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScope unmarshals an instance of Scope from the specified map of raw messages.

func UnmarshalScopeItem 

func UnmarshalScopeItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScopeItem unmarshals an instance of ScopeItem from the specified map of raw messages.

func UnmarshalScopesList 

func UnmarshalScopesList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalScopesList unmarshals an instance of ScopesList from the specified map of raw messages.

func UnmarshalSummariesList 

func UnmarshalSummariesList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSummariesList unmarshals an instance of SummariesList from the specified map of raw messages.

func UnmarshalSummariesListFirst 

func UnmarshalSummariesListFirst(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSummariesListFirst unmarshals an instance of SummariesListFirst from the specified map of raw messages.

func UnmarshalSummariesListLast 

func UnmarshalSummariesListLast(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSummariesListLast unmarshals an instance of SummariesListLast from the specified map of raw messages.

func UnmarshalSummariesListNext 

func UnmarshalSummariesListNext(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSummariesListNext unmarshals an instance of SummariesListNext from the specified map of raw messages.

func UnmarshalSummariesListPrevious 

func UnmarshalSummariesListPrevious(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSummariesListPrevious unmarshals an instance of SummariesListPrevious from the specified map of raw messages.

func UnmarshalSummary 

func UnmarshalSummary(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSummary unmarshals an instance of Summary from the specified map of raw messages.

func UnmarshalSummaryItem 

func UnmarshalSummaryItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSummaryItem unmarshals an instance of SummaryItem from the specified map of raw messages.

Types

type ApplicabilityCriteria 

type ApplicabilityCriteria struct {
	// A list of environments that a profile can be applied to.
	Environment []string `json:"environment,omitempty"`

	// A list of resources that a profile can be used with.
	Resource []string `json:"resource,omitempty"`

	// The type of environment that a profile is able to be applied to.
	EnvironmentCategory []string `json:"environment_category,omitempty"`

	// The type of resource that a profile is able to be applied to.
	ResourceCategory []string `json:"resource_category,omitempty"`

	// The resource type that the profile applies to.
	ResourceType []string `json:"resource_type,omitempty"`

	// The software that the profile applies to.
	SoftwareDetails interface{} `json:"software_details,omitempty"`

	// The operatoring system that the profile applies to.
	OsDetails interface{} `json:"os_details,omitempty"`

	// Any additional details about the profile.
	AdditionalDetails interface{} `json:"additional_details,omitempty"`

	// The type of environment that your scope is targeted to.
	EnvironmentCategoryDescription map[string]string `json:"environment_category_description,omitempty"`

	// The environment that your scope is targeted to.
	EnvironmentDescription map[string]string `json:"environment_description,omitempty"`

	// The type of resource that your scope is targeted to.
	ResourceCategoryDescription map[string]string `json:"resource_category_description,omitempty"`

	// A further classification of the type of resource that your scope is targeted to.
	ResourceTypeDescription map[string]string `json:"resource_type_description,omitempty"`

	// The resource that is scanned as part of your scope.
	ResourceDescription map[string]string `json:"resource_description,omitempty"`
}

ApplicabilityCriteria : The criteria that defines how a profile applies.

type Collector 

type Collector struct {
	// An identifier of the collector.
	CollectorID *string `json:"collector_id,omitempty"`
}

Collector : The instance of the collector.

type Control 

type Control struct {
	// The scan summary control ID.
	ControlID *string `json:"control_id,omitempty"`

	// The control status.
	Status *string `json:"status,omitempty"`

	// The external control ID.
	ExternalControlID *string `json:"external_control_id,omitempty"`

	// The scan profile name.
	ControlDesciption *string `json:"control_desciption,omitempty"`

	// The list of goals on the control.
	Goals []Goal `json:"goals,omitempty"`

	// A scans summary controls.
	ResourceStatistics *ResourceStatistics `json:"resource_statistics,omitempty"`
}

Control : A scans summary controls.

type CreateCollectorOptions 

type CreateCollectorOptions struct {
	// A unique name for your collector.
	CollectorName *string

	// A detailed description of the collector.
	CollectorDescription *string

	// Determines whether the collector endpoint is accessible on a public network. If set to `true`, the collector
	// connects to resources in your account over a public network. If set to `false`, the collector connects to resources
	// by using a private IP that is accessible only through the IBM Cloud private network.
	IsPublic *bool

	// Determines whether the collector is an IBM or customer-managed virtual machine. Use `ibm` to allow Security and
	// Compliance Center to create, install, and manage the collector on your behalf. The collector is installed in an
	// OpenShift cluster and approved automatically for use. Use `customer` if you would like to install the collector by
	// using your own virtual machine. For more information, check out the
	// [docs](https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-collector).
	ManagedBy *string

	// To protect the credentials that you add to the service, a passphrase is used to generate a data encryption key. The
	// key is used to securely store your credentials and prevent anyone from accessing them.
	PassPhrase *string

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateCollectorOptions : The CreateCollector options.

func (*CreateCollectorOptions) SetCollectorDescription 

func (_options *CreateCollectorOptions) SetCollectorDescription(collectorDescription string) *CreateCollectorOptions

SetCollectorDescription : Allow user to set CollectorDescription

func (*CreateCollectorOptions) SetCollectorName 

func (_options *CreateCollectorOptions) SetCollectorName(collectorName string) *CreateCollectorOptions

SetCollectorName : Allow user to set CollectorName

func (*CreateCollectorOptions) SetHeaders 

func (options *CreateCollectorOptions) SetHeaders(param map[string]string) *CreateCollectorOptions

SetHeaders : Allow user to set Headers

func (*CreateCollectorOptions) SetIsPublic 

func (_options *CreateCollectorOptions) SetIsPublic(isPublic bool) *CreateCollectorOptions

SetIsPublic : Allow user to set IsPublic

func (*CreateCollectorOptions) SetManagedBy 

func (_options *CreateCollectorOptions) SetManagedBy(managedBy string) *CreateCollectorOptions

SetManagedBy : Allow user to set ManagedBy

func (*CreateCollectorOptions) SetPassPhrase 

func (_options *CreateCollectorOptions) SetPassPhrase(passPhrase string) *CreateCollectorOptions

SetPassPhrase : Allow user to set PassPhrase

func (*CreateCollectorOptions) SetTransactionID 

func (_options *CreateCollectorOptions) SetTransactionID(transactionID string) *CreateCollectorOptions

SetTransactionID : Allow user to set TransactionID

type CreateCredentialOptions 

type CreateCredentialOptions struct {
	// The credential data file that you want to use to allow a collector to access and scan your IT resources. Depending
	// on the type of resources that you want to scan, you might provide an API key, an access key file, or a username and
	// password to a specific resource. For more information, see the
	// [docs](https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-credentials).
	CredentialDataFile io.ReadCloser `validate:"required"`

	// A PEM file to associate with the credential data file.
	PemFile io.ReadCloser

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateCredentialOptions : The CreateCredential options.

func (*CreateCredentialOptions) SetCredentialDataFile 

func (_options *CreateCredentialOptions) SetCredentialDataFile(credentialDataFile io.ReadCloser) *CreateCredentialOptions

SetCredentialDataFile : Allow user to set CredentialDataFile

func (*CreateCredentialOptions) SetHeaders 

func (options *CreateCredentialOptions) SetHeaders(param map[string]string) *CreateCredentialOptions

SetHeaders : Allow user to set Headers

func (*CreateCredentialOptions) SetPemFile 

func (_options *CreateCredentialOptions) SetPemFile(pemFile io.ReadCloser) *CreateCredentialOptions

SetPemFile : Allow user to set PemFile

func (*CreateCredentialOptions) SetTransactionID 

func (_options *CreateCredentialOptions) SetTransactionID(transactionID string) *CreateCredentialOptions

SetTransactionID : Allow user to set TransactionID

type CreateScopeOptions 

type CreateScopeOptions struct {
	// A unique name for your scope.
	ScopeName *string

	// A detailed description of the scope.
	ScopeDescription *string

	// The unique IDs of the collectors that are attached to the scope.
	CollectorIds []string

	// The unique identifier of the credential.
	CredentialID *string

	// The environment that the scope is targeted to.
	EnvironmentType *string

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateScopeOptions : The CreateScope options.

func (*CreateScopeOptions) SetCollectorIds 

func (_options *CreateScopeOptions) SetCollectorIds(collectorIds []string) *CreateScopeOptions

SetCollectorIds : Allow user to set CollectorIds

func (*CreateScopeOptions) SetCredentialID 

func (_options *CreateScopeOptions) SetCredentialID(credentialID string) *CreateScopeOptions

SetCredentialID : Allow user to set CredentialID

func (*CreateScopeOptions) SetEnvironmentType 

func (_options *CreateScopeOptions) SetEnvironmentType(environmentType string) *CreateScopeOptions

SetEnvironmentType : Allow user to set EnvironmentType

func (*CreateScopeOptions) SetHeaders 

func (options *CreateScopeOptions) SetHeaders(param map[string]string) *CreateScopeOptions

SetHeaders : Allow user to set Headers

func (*CreateScopeOptions) SetScopeDescription 

func (_options *CreateScopeOptions) SetScopeDescription(scopeDescription string) *CreateScopeOptions

SetScopeDescription : Allow user to set ScopeDescription

func (*CreateScopeOptions) SetScopeName 

func (_options *CreateScopeOptions) SetScopeName(scopeName string) *CreateScopeOptions

SetScopeName : Allow user to set ScopeName

func (*CreateScopeOptions) SetTransactionID 

func (_options *CreateScopeOptions) SetTransactionID(transactionID string) *CreateScopeOptions

SetTransactionID : Allow user to set TransactionID

type CreateValidationOptions 

type CreateValidationOptions struct {
	// The unique ID of the scope.
	ScopeID *string `validate:"required"`

	// The unique ID of the profile.
	ProfileID *string `validate:"required"`

	// The ID of the profile group.
	GroupProfileID *string

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateValidationOptions : The CreateValidation options.

func (*CreateValidationOptions) SetGroupProfileID 

func (_options *CreateValidationOptions) SetGroupProfileID(groupProfileID string) *CreateValidationOptions

SetGroupProfileID : Allow user to set GroupProfileID

func (*CreateValidationOptions) SetHeaders 

func (options *CreateValidationOptions) SetHeaders(param map[string]string) *CreateValidationOptions

SetHeaders : Allow user to set Headers

func (*CreateValidationOptions) SetProfileID 

func (_options *CreateValidationOptions) SetProfileID(profileID string) *CreateValidationOptions

SetProfileID : Allow user to set ProfileID

func (*CreateValidationOptions) SetScopeID 

func (_options *CreateValidationOptions) SetScopeID(scopeID string) *CreateValidationOptions

SetScopeID : Allow user to set ScopeID

func (*CreateValidationOptions) SetTransactionID 

func (_options *CreateValidationOptions) SetTransactionID(transactionID string) *CreateValidationOptions

SetTransactionID : Allow user to set TransactionID

type Credential 

type Credential struct {
	// The unique ID of the credential.
	CredentialID *string `json:"credential_id,omitempty"`

	// The name of the credential.
	CredentialName *string `json:"credential_name,omitempty"`

	// The creation time of the credential.
	CreatedTime *strfmt.DateTime `json:"created_time,omitempty"`
}

Credential : The details of the created credential.

type Goal 

type Goal struct {
	// The description of the goal.
	GoalDescription *string `json:"goal_description,omitempty"`

	// The goal ID.
	GoalID *string `json:"goal_id,omitempty"`

	// The goal status.
	Status *string `json:"status,omitempty"`

	// The severity of the goal.
	Severity *string `json:"severity,omitempty"`

	// The report completed time.
	CompletedTime *strfmt.DateTime `json:"completed_time,omitempty"`

	// The error on goal validation.
	Error *string `json:"error,omitempty"`

	// The list of resource results.
	ResourceResult []ResourceResult `json:"resource_result,omitempty"`

	// The criteria that defines how a profile applies.
	GoalApplicabilityCriteria *GoalApplicabilityCriteria `json:"goal_applicability_criteria,omitempty"`
}

Goal : The goals on goals list.

type GoalApplicabilityCriteria 

type GoalApplicabilityCriteria struct {
	// A list of environments that a profile can be applied to.
	Environment []string `json:"environment,omitempty"`

	// A list of resources that a profile can be used with.
	Resource []string `json:"resource,omitempty"`

	// The type of environment that a profile is able to be applied to.
	EnvironmentCategory []string `json:"environment_category,omitempty"`

	// The type of resource that a profile is able to be applied to.
	ResourceCategory []string `json:"resource_category,omitempty"`

	// The resource type that the profile applies to.
	ResourceType []string `json:"resource_type,omitempty"`

	// The software that the profile applies to.
	SoftwareDetails interface{} `json:"software_details,omitempty"`

	// The operating system that the profile applies to.
	OsDetails interface{} `json:"os_details,omitempty"`

	// Any additional details about the profile.
	AdditionalDetails interface{} `json:"additional_details,omitempty"`

	// The type of environment that your scope is targeted to.
	EnvironmentCategoryDescription map[string]string `json:"environment_category_description,omitempty"`

	// The environment that your scope is targeted to.
	EnvironmentDescription map[string]string `json:"environment_description,omitempty"`

	// The type of resource that your scope is targeted to.
	ResourceCategoryDescription map[string]string `json:"resource_category_description,omitempty"`

	// A further classification of the type of resource that your scope is targeted to.
	ResourceTypeDescription map[string]string `json:"resource_type_description,omitempty"`

	// The resource that is scanned as part of your scope.
	ResourceDescription map[string]string `json:"resource_description,omitempty"`
}

GoalApplicabilityCriteria : The criteria that defines how a profile applies.

type GroupProfileResult 

type GroupProfileResult struct {
	// The group ID of profile.
	GroupProfileID *string `json:"group_profile_id,omitempty"`

	// The group name of the profile.
	GroupProfileName *string `json:"group_profile_name,omitempty"`

	// The type of profile. To learn more about profile types, check out the [docs]
	// (https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-profiles).
	ProfileType *string `json:"profile_type,omitempty"`

	// The result of a scan.
	ValidationResult *ScanResult `json:"validation_result,omitempty"`

	// The result of a each profile in group profile.
	Profiles []ProfilesResult `json:"profiles,omitempty"`
}

GroupProfileResult : The result of a group profile.

type ListLatestScansOptions 

type ListLatestScansOptions struct {
	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request.
	TransactionID *string

	// The offset of the profiles.
	Offset *int64

	// The number of profiles that are included per page.
	Limit *int64

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListLatestScansOptions : The ListLatestScans options.

func (*ListLatestScansOptions) SetHeaders 

func (options *ListLatestScansOptions) SetHeaders(param map[string]string) *ListLatestScansOptions

SetHeaders : Allow user to set Headers

func (*ListLatestScansOptions) SetLimit 

func (_options *ListLatestScansOptions) SetLimit(limit int64) *ListLatestScansOptions

SetLimit : Allow user to set Limit

func (*ListLatestScansOptions) SetOffset 

func (_options *ListLatestScansOptions) SetOffset(offset int64) *ListLatestScansOptions

SetOffset : Allow user to set Offset

func (*ListLatestScansOptions) SetTransactionID 

func (_options *ListLatestScansOptions) SetTransactionID(transactionID string) *ListLatestScansOptions

SetTransactionID : Allow user to set TransactionID

type ListProfilesOptions 

type ListProfilesOptions struct {
	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request.
	TransactionID *string

	// The offset of the profiles.
	Offset *int64

	// The number of profiles that are included per page.
	Limit *int64

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListProfilesOptions : The ListProfiles options.

func (*ListProfilesOptions) SetHeaders 

func (options *ListProfilesOptions) SetHeaders(param map[string]string) *ListProfilesOptions

SetHeaders : Allow user to set Headers

func (*ListProfilesOptions) SetLimit 

func (_options *ListProfilesOptions) SetLimit(limit int64) *ListProfilesOptions

SetLimit : Allow user to set Limit

func (*ListProfilesOptions) SetOffset 

func (_options *ListProfilesOptions) SetOffset(offset int64) *ListProfilesOptions

SetOffset : Allow user to set Offset

func (*ListProfilesOptions) SetTransactionID 

func (_options *ListProfilesOptions) SetTransactionID(transactionID string) *ListProfilesOptions

SetTransactionID : Allow user to set TransactionID

type ListScopesOptions 

type ListScopesOptions struct {
	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListScopesOptions : The ListScopes options.

func (*ListScopesOptions) SetHeaders 

func (options *ListScopesOptions) SetHeaders(param map[string]string) *ListScopesOptions

SetHeaders : Allow user to set Headers

func (*ListScopesOptions) SetTransactionID 

func (_options *ListScopesOptions) SetTransactionID(transactionID string) *ListScopesOptions

SetTransactionID : Allow user to set TransactionID

type PostureManagementV1 

type PostureManagementV1 struct {
	Service *core.BaseService

	// Your IBM Cloud account ID.
	AccountID *string
}

PostureManagementV1 : With IBM Cloud® Security and Compliance Center, you can embed checks into your every day workflows to help manage your current security and compliance posture. By monitoring for risks, you can identify security vulnerabilities and quickly work to mitigate the impact.

Version: 1.0.0

func NewPostureManagementV1 

func NewPostureManagementV1(options *PostureManagementV1Options) (service *PostureManagementV1, err error)

NewPostureManagementV1 : constructs an instance of PostureManagementV1 with passed in options.

func NewPostureManagementV1UsingExternalConfig 

func NewPostureManagementV1UsingExternalConfig(options *PostureManagementV1Options) (postureManagement *PostureManagementV1, err error)

NewPostureManagementV1UsingExternalConfig : constructs an instance of PostureManagementV1 with passed in options and external configuration.

func (*PostureManagementV1) Clone 

func (postureManagement *PostureManagementV1) Clone() *PostureManagementV1

Clone makes a copy of "postureManagement" suitable for processing requests.

func (*PostureManagementV1) CreateCollector 

func (postureManagement *PostureManagementV1) CreateCollector(createCollectorOptions *CreateCollectorOptions) (result *Collector, response *core.DetailedResponse, err error)

CreateCollector : Create a collector Create a collector to fetch the configuration information of your resources and then validate it by using a specified profile.

func (*PostureManagementV1) CreateCollectorWithContext 

func (postureManagement *PostureManagementV1) CreateCollectorWithContext(ctx context.Context, createCollectorOptions *CreateCollectorOptions) (result *Collector, response *core.DetailedResponse, err error)

CreateCollectorWithContext is an alternate form of the CreateCollector method which supports a Context parameter

func (*PostureManagementV1) CreateCredential 

func (postureManagement *PostureManagementV1) CreateCredential(createCredentialOptions *CreateCredentialOptions) (result *Credential, response *core.DetailedResponse, err error)

CreateCredential : Create a credential Add an existing credential that can be used by a collector to access your resources in order to gather information about your configurations, validate them, and initiate any remediation where possible.

func (*PostureManagementV1) CreateCredentialWithContext 

func (postureManagement *PostureManagementV1) CreateCredentialWithContext(ctx context.Context, createCredentialOptions *CreateCredentialOptions) (result *Credential, response *core.DetailedResponse, err error)

CreateCredentialWithContext is an alternate form of the CreateCredential method which supports a Context parameter

func (*PostureManagementV1) CreateScope 

func (postureManagement *PostureManagementV1) CreateScope(createScopeOptions *CreateScopeOptions) (result *Scope, response *core.DetailedResponse, err error)

CreateScope : Create a scope A scope is the selection of resources that you want to validate the configuration of.

func (*PostureManagementV1) CreateScopeWithContext 

func (postureManagement *PostureManagementV1) CreateScopeWithContext(ctx context.Context, createScopeOptions *CreateScopeOptions) (result *Scope, response *core.DetailedResponse, err error)

CreateScopeWithContext is an alternate form of the CreateScope method which supports a Context parameter

func (*PostureManagementV1) CreateValidation 

func (postureManagement *PostureManagementV1) CreateValidation(createValidationOptions *CreateValidationOptions) (result *Result, response *core.DetailedResponse, err error)

CreateValidation : Initiate a validation scan Validation scans determine a specified scope's adherence to regulatory controls by validating the configuration of the resources in your scope to the attached profile. To initiate a scan, you must have configured a collector, provided credentials, and completed both a fact collection and discovery scan. [Learn more](/docs/security-compliance?topic=security-compliance-schedule-scan).

func (*PostureManagementV1) CreateValidationWithContext 

func (postureManagement *PostureManagementV1) CreateValidationWithContext(ctx context.Context, createValidationOptions *CreateValidationOptions) (result *Result, response *core.DetailedResponse, err error)

CreateValidationWithContext is an alternate form of the CreateValidation method which supports a Context parameter

func (*PostureManagementV1) DisableRetries 

func (postureManagement *PostureManagementV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*PostureManagementV1) EnableRetries 

func (postureManagement *PostureManagementV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*PostureManagementV1) GetEnableGzipCompression 

func (postureManagement *PostureManagementV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*PostureManagementV1) GetServiceURL 

func (postureManagement *PostureManagementV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*PostureManagementV1) ListLatestScans 

func (postureManagement *PostureManagementV1) ListLatestScans(listLatestScansOptions *ListLatestScansOptions) (result *ScansList, response *core.DetailedResponse, err error)

ListLatestScans : List latest scans List the last scan results that are available in your account for each profile and scope combination.

func (*PostureManagementV1) ListLatestScansWithContext 

func (postureManagement *PostureManagementV1) ListLatestScansWithContext(ctx context.Context, listLatestScansOptions *ListLatestScansOptions) (result *ScansList, response *core.DetailedResponse, err error)

ListLatestScansWithContext is an alternate form of the ListLatestScans method which supports a Context parameter

func (*PostureManagementV1) ListProfiles 

func (postureManagement *PostureManagementV1) ListProfiles(listProfilesOptions *ListProfilesOptions) (result *ProfilesList, response *core.DetailedResponse, err error)

ListProfiles : List profiles List all of the profiles that are available in your account. To view a specific profile, you can filter by name.

func (*PostureManagementV1) ListProfilesWithContext 

func (postureManagement *PostureManagementV1) ListProfilesWithContext(ctx context.Context, listProfilesOptions *ListProfilesOptions) (result *ProfilesList, response *core.DetailedResponse, err error)

ListProfilesWithContext is an alternate form of the ListProfiles method which supports a Context parameter

func (*PostureManagementV1) ListScopes 

func (postureManagement *PostureManagementV1) ListScopes(listScopesOptions *ListScopesOptions) (result *ScopesList, response *core.DetailedResponse, err error)

ListScopes : List scopes List all of the scopes that are available in your account. To view a specific scope, you can filter by name.

func (*PostureManagementV1) ListScopesWithContext 

func (postureManagement *PostureManagementV1) ListScopesWithContext(ctx context.Context, listScopesOptions *ListScopesOptions) (result *ScopesList, response *core.DetailedResponse, err error)

ListScopesWithContext is an alternate form of the ListScopes method which supports a Context parameter

func (*PostureManagementV1) NewCreateCollectorOptions 

func (*PostureManagementV1) NewCreateCollectorOptions() *CreateCollectorOptions

NewCreateCollectorOptions : Instantiate CreateCollectorOptions

func (*PostureManagementV1) NewCreateCredentialOptions 

func (*PostureManagementV1) NewCreateCredentialOptions(credentialDataFile io.ReadCloser) *CreateCredentialOptions

NewCreateCredentialOptions : Instantiate CreateCredentialOptions

func (*PostureManagementV1) NewCreateScopeOptions 

func (*PostureManagementV1) NewCreateScopeOptions() *CreateScopeOptions

NewCreateScopeOptions : Instantiate CreateScopeOptions

func (*PostureManagementV1) NewCreateValidationOptions 

func (*PostureManagementV1) NewCreateValidationOptions(scopeID string, profileID string) *CreateValidationOptions

NewCreateValidationOptions : Instantiate CreateValidationOptions

func (*PostureManagementV1) NewListLatestScansOptions 

func (*PostureManagementV1) NewListLatestScansOptions() *ListLatestScansOptions

NewListLatestScansOptions : Instantiate ListLatestScansOptions

func (*PostureManagementV1) NewListProfilesOptions 

func (*PostureManagementV1) NewListProfilesOptions() *ListProfilesOptions

NewListProfilesOptions : Instantiate ListProfilesOptions

func (*PostureManagementV1) NewListScopesOptions 

func (*PostureManagementV1) NewListScopesOptions() *ListScopesOptions

NewListScopesOptions : Instantiate ListScopesOptions

func (*PostureManagementV1) NewScanSummariesOptions 

func (*PostureManagementV1) NewScanSummariesOptions(profileID string, scopeID string) *ScanSummariesOptions

NewScanSummariesOptions : Instantiate ScanSummariesOptions

func (*PostureManagementV1) NewScansSummaryOptions 

func (*PostureManagementV1) NewScansSummaryOptions(scanID string, profileID string) *ScansSummaryOptions

NewScansSummaryOptions : Instantiate ScansSummaryOptions

func (*PostureManagementV1) ScanSummaries 

func (postureManagement *PostureManagementV1) ScanSummaries(scanSummariesOptions *ScanSummariesOptions) (result *SummariesList, response *core.DetailedResponse, err error)

ScanSummaries : View scan summaries List all of the previous and current validation summaries for a specific scan.

func (*PostureManagementV1) ScanSummariesWithContext 

func (postureManagement *PostureManagementV1) ScanSummariesWithContext(ctx context.Context, scanSummariesOptions *ScanSummariesOptions) (result *SummariesList, response *core.DetailedResponse, err error)

ScanSummariesWithContext is an alternate form of the ScanSummaries method which supports a Context parameter

func (*PostureManagementV1) ScansSummary 

func (postureManagement *PostureManagementV1) ScansSummary(scansSummaryOptions *ScansSummaryOptions) (result *Summary, response *core.DetailedResponse, err error)

ScansSummary : View a specified scan Retrieve the results summary of a validation scan by specifying a scan and profile ID combination. To obtain your profile ID and scan ID for your most recent scan, make a GET request to the "/posture/v1/scans/validations/latest_scans" endpoint.

func (*PostureManagementV1) ScansSummaryWithContext 

func (postureManagement *PostureManagementV1) ScansSummaryWithContext(ctx context.Context, scansSummaryOptions *ScansSummaryOptions) (result *Summary, response *core.DetailedResponse, err error)

ScansSummaryWithContext is an alternate form of the ScansSummary method which supports a Context parameter

func (*PostureManagementV1) SetDefaultHeaders 

func (postureManagement *PostureManagementV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*PostureManagementV1) SetEnableGzipCompression 

func (postureManagement *PostureManagementV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*PostureManagementV1) SetServiceURL 

func (postureManagement *PostureManagementV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type PostureManagementV1Options 

type PostureManagementV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Your IBM Cloud account ID.
	AccountID *string `validate:"required"`
}

PostureManagementV1Options : Service options

type ProfileItem 

type ProfileItem struct {
	// The name of the profile.
	Name *string `json:"name,omitempty"`

	// A description of the profile.
	Description *string `json:"description,omitempty"`

	// The version of the profile.
	Version *int64 `json:"version,omitempty"`

	// The user who created the profile.
	CreatedBy *string `json:"created_by,omitempty"`

	// The user who last modified the profile.
	ModifiedBy *string `json:"modified_by,omitempty"`

	// A reason that you want to delete a profile.
	ReasonForDelete *string `json:"reason_for_delete,omitempty"`

	// The criteria that defines how a profile applies.
	ApplicabilityCriteria *ApplicabilityCriteria `json:"applicability_criteria,omitempty"`

	// An auto-generated unique identifying number of the profile.
	ProfileID *string `json:"profile_id,omitempty"`

	// The base profile that the controls are pulled from.
	BaseProfile *string `json:"base_profile,omitempty"`

	// The type of profile.
	ProfileType *string `json:"profile_type,omitempty"`

	// The time that the profile was created in UTC.
	CreatedTime *strfmt.DateTime `json:"created_time,omitempty"`

	// The time that the profile was most recently modified in UTC.
	ModifiedTime *strfmt.DateTime `json:"modified_time,omitempty"`

	// The profile status. If the profile is enabled, the value is true. If the profile is disabled, the value is false.
	Enabled *bool `json:"enabled,omitempty"`
}

ProfileItem : Profile.

type ProfileResult 

type ProfileResult struct {
	// The ID of the profile.
	ProfileID *string `json:"profile_id,omitempty"`

	// The name of the profile.
	ProfileName *string `json:"profile_name,omitempty"`

	// The type of profile. To learn more about profile types, check out the [docs]
	// (https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-profiles).
	ProfileType *string `json:"profile_type,omitempty"`

	// The result of a scan.
	ValidationResult *ScanResult `json:"validation_result,omitempty"`
}

ProfileResult : The result of a profile.

type ProfilesList 

type ProfilesList struct {
	// The offset of the page.
	Offset *int64 `json:"offset" validate:"required"`

	// The number of profiles displayed per page.
	Limit *int64 `json:"limit" validate:"required"`

	// The total number of profiles.
	TotalCount *int64 `json:"total_count,omitempty"`

	// The URL of the first page of profiles.
	First *ProfilesListFirst `json:"first,omitempty"`

	// The URL of the last page of profiles.
	Last *ProfilesListLast `json:"last,omitempty"`

	// The URL of the previous page of profiles.
	Previous *ProfilesListPrevious `json:"previous,omitempty"`

	// The URL of the next page of profiles.
	Next *ProfilesListNext `json:"next,omitempty"`

	// Profiles.
	Profiles []ProfileItem `json:"profiles,omitempty"`
}

ProfilesList : A list of profiles.

func (*ProfilesList) GetNextOffset 

func (resp *ProfilesList) GetNextOffset() (*int64, error)

Retrieve the value to be passed to a request to access the next page of results

type ProfilesListFirst 

type ProfilesListFirst struct {
	// The URL of the first page of profiles.
	Href *string `json:"href,omitempty"`
}

ProfilesListFirst : The URL of the first page of profiles.

type ProfilesListLast 

type ProfilesListLast struct {
	// The URL of the last page of profiles.
	Href *string `json:"href,omitempty"`
}

ProfilesListLast : The URL of the last page of profiles.

type ProfilesListNext 

type ProfilesListNext struct {
	// The URL of the next page of profiles.
	Href *string `json:"href,omitempty"`
}

ProfilesListNext : The URL of the next page of profiles.

type ProfilesListPrevious 

type ProfilesListPrevious struct {
	// The URL of the previous page of profiles.
	Href *string `json:"href,omitempty"`
}

ProfilesListPrevious : The URL of the previous page of profiles.

type ProfilesResult 

type ProfilesResult struct {
	// The ID of the profile.
	ProfileID *string `json:"profile_id,omitempty"`

	// The name of the profile.
	ProfileName *string `json:"profile_name,omitempty"`

	// The type of profile. To learn more about profile types, check out the [docs]
	// (https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-profiles).
	ProfileType *string `json:"profile_type,omitempty"`

	// The result of a scan.
	ValidationResult *Results `json:"validation_result,omitempty"`
}

ProfilesResult : The result of a each profile data in group profile.

type ResourceResult 

type ResourceResult struct {
	// The resource name.
	ResourceName *string `json:"resource_name,omitempty"`

	// The resource type.
	ResourceTypes *string `json:"resource_types,omitempty"`

	// The resource control result status.
	ResourceStatus *string `json:"resource_status,omitempty"`

	// The expected results of a resource.
	DisplayExpectedValue *string `json:"display_expected_value,omitempty"`

	// The actual results of a resource.
	ActualValue *string `json:"actual_value,omitempty"`

	// The results information.
	ResultsInfo *string `json:"results_info,omitempty"`

	// The reason for goal not applicable for a resource.
	NotApplicableReason *string `json:"not_applicable_reason,omitempty"`
}

ResourceResult : The resource results.

type ResourceStatistics 

type ResourceStatistics struct {
	// The resource count of pass controls.
	ResourcePassCount *int64 `json:"resource_pass_count,omitempty"`

	// The resource count of fail controls.
	ResourceFailCount *int64 `json:"resource_fail_count,omitempty"`

	// The number of resources that were unable to be scanned against a control.
	ResourceUnableToPerformCount *int64 `json:"resource_unable_to_perform_count,omitempty"`

	// The resource count of not applicable(na) controls.
	ResourceNotApplicableCount *int64 `json:"resource_not_applicable_count,omitempty"`
}

ResourceStatistics : A scans summary controls.

type Result 

type Result struct {
	// Result.
	Result *bool `json:"result,omitempty"`

	// A message is returned.
	Message *string `json:"message,omitempty"`
}

Result : Result.

type Results 

type Results struct {
	// The number of controls that passed the scan.
	ControlsPassCount *int64 `json:"controls_pass_count,omitempty"`

	// The number of controls that failed the scan.
	ControlsFailCount *int64 `json:"controls_fail_count,omitempty"`

	// The number of controls that are not relevant to the current scan. A scan is listed as 'Not applicable' when
	// information about its associated resource can't be found.
	ControlsNotApplicableCount *int64 `json:"controls_not_applicable_count,omitempty"`

	// The number of controls that could not be validated. A control is listed as 'Unable to perform' when information
	// about its associated resource can't be collected.
	ControlsUnableToPerformCount *int64 `json:"controls_unable_to_perform_count,omitempty"`

	// The total number of controls that were included in the scan.
	ControlsTotalCount *int64 `json:"controls_total_count,omitempty"`
}

Results : The result of a scan.

type Scan 

type Scan struct {
	// An auto-generated unique identifier for the scan.
	ScanID *string `json:"scan_id,omitempty"`

	// An auto-generated unique identifier for discovery.
	DiscoverID *string `json:"discover_id,omitempty"`

	// The status of the collector as it completes a scan.
	Status *string `json:"status,omitempty"`

	// The current status of the collector.
	StatusMessage *string `json:"status_message,omitempty"`
}

Scan : Scan.

type ScanItem 

type ScanItem struct {
	// The ID of the scan.
	ScanID *string `json:"scan_id,omitempty"`

	// A system generated name that is the combination of 12 characters in the scope name and 12 characters of a profile
	// name.
	ScanName *string `json:"scan_name,omitempty"`

	// The ID of the scan.
	ScopeID *string `json:"scope_id,omitempty"`

	// The name of the scope.
	ScopeName *string `json:"scope_name,omitempty"`

	// The ID of the profile.
	ProfileID *string `json:"profile_id,omitempty"`

	// The name of the profile.
	ProfileName *string `json:"profile_name,omitempty"`

	// The type of profile. To learn more about profile types, check out the [docs]
	// (https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-profiles).
	ProfileType *string `json:"profile_type,omitempty"`

	// The group ID of profile.
	GroupProfileID *string `json:"group_profile_id,omitempty"`

	// The group name of the profile.
	GroupProfileName *string `json:"group_profile_name,omitempty"`

	// The entity that ran the report.
	ReportRunBy *string `json:"report_run_by,omitempty"`

	// The date and time the scan was run.
	StartTime *strfmt.DateTime `json:"start_time,omitempty"`

	// The date and time the scan completed.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// The result of a scan.
	Result *ScanResult `json:"result,omitempty"`
}

ScanItem : The details of a scan.

type ScanResult 

type ScanResult struct {
	// The number of goals that passed the scan.
	GoalsPassCount *int64 `json:"goals_pass_count,omitempty"`

	// The number of goals that could not be validated. A control is listed as 'Unable to perform' when information about
	// its associated resource can't be collected.
	GoalsUnableToPerformCount *int64 `json:"goals_unable_to_perform_count,omitempty"`

	// The number of goals that are not relevant to the current scan. A scan is listed as 'Not applicable' when information
	// about its associated resource can't be found.
	GoalsNotApplicableCount *int64 `json:"goals_not_applicable_count,omitempty"`

	// The number of goals that failed the scan.
	GoalsFailCount *int64 `json:"goals_fail_count,omitempty"`

	// The total number of goals that were included in the scan.
	GoalsTotalCount *int64 `json:"goals_total_count,omitempty"`

	// The number of controls that passed the scan.
	ControlsPassCount *int64 `json:"controls_pass_count,omitempty"`

	// The number of controls that failed the scan.
	ControlsFailCount *int64 `json:"controls_fail_count,omitempty"`

	// The number of controls that are not relevant to the current scan. A scan is listed as 'Not applicable' when
	// information about its associated resource can't be found.
	ControlsNotApplicableCount *int64 `json:"controls_not_applicable_count,omitempty"`

	// The number of controls that could not be validated. A control is listed as 'Unable to perform' when information
	// about its associated resource can't be collected.
	ControlsUnableToPerformCount *int64 `json:"controls_unable_to_perform_count,omitempty"`

	// The total number of controls that were included in the scan.
	ControlsTotalCount *int64 `json:"controls_total_count,omitempty"`
}

ScanResult : The result of a scan.

type ScanSummariesOptions 

type ScanSummariesOptions struct {
	// The profile ID. This can be obtained from the Security and Compliance Center UI by clicking on the profile name. The
	// URL contains the ID.
	ProfileID *string `validate:"required"`

	// The scope ID. This can be obtained from the Security and Compliance Center UI by clicking on the scope name. The URL
	// contains the ID.
	ScopeID *string `validate:"required"`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request.
	TransactionID *string

	// The offset of the profiles.
	Offset *int64

	// The number of profiles that are included per page.
	Limit *int64

	// Allows users to set headers on API requests
	Headers map[string]string
}

ScanSummariesOptions : The ScanSummaries options.

func (*ScanSummariesOptions) SetHeaders 

func (options *ScanSummariesOptions) SetHeaders(param map[string]string) *ScanSummariesOptions

SetHeaders : Allow user to set Headers

func (*ScanSummariesOptions) SetLimit 

func (_options *ScanSummariesOptions) SetLimit(limit int64) *ScanSummariesOptions

SetLimit : Allow user to set Limit

func (*ScanSummariesOptions) SetOffset 

func (_options *ScanSummariesOptions) SetOffset(offset int64) *ScanSummariesOptions

SetOffset : Allow user to set Offset

func (*ScanSummariesOptions) SetProfileID 

func (_options *ScanSummariesOptions) SetProfileID(profileID string) *ScanSummariesOptions

SetProfileID : Allow user to set ProfileID

func (*ScanSummariesOptions) SetScopeID 

func (_options *ScanSummariesOptions) SetScopeID(scopeID string) *ScanSummariesOptions

SetScopeID : Allow user to set ScopeID

func (*ScanSummariesOptions) SetTransactionID 

func (_options *ScanSummariesOptions) SetTransactionID(transactionID string) *ScanSummariesOptions

SetTransactionID : Allow user to set TransactionID

type ScansList 

type ScansList struct {
	// The offset of the page.
	Offset *int64 `json:"offset" validate:"required"`

	// The number of scans displayed per page.
	Limit *int64 `json:"limit" validate:"required"`

	// The total number of scans in the list.
	TotalCount *int64 `json:"total_count,omitempty"`

	// The URL of the first page of scans.
	First *ScansListFirst `json:"first,omitempty"`

	// The URL of the last page of scans.
	Last *ScansListLast `json:"last,omitempty"`

	// The URL of the previous page of scans.
	Previous *ScansListPrevious `json:"previous,omitempty"`

	// The URL of the next page of scans.
	Next *ScansListNext `json:"next,omitempty"`

	// The details of a scan.
	LatestScans []ScanItem `json:"latest_scans,omitempty"`
}

ScansList : A list of scans.

func (*ScansList) GetNextOffset 

func (resp *ScansList) GetNextOffset() (*int64, error)

Retrieve the value to be passed to a request to access the next page of results

type ScansListFirst 

type ScansListFirst struct {
	// The URL of the first page of scans.
	Href *string `json:"href,omitempty"`
}

ScansListFirst : The URL of the first page of scans.

type ScansListLast 

type ScansListLast struct {
	// The URL of the last page of scans.
	Href *string `json:"href,omitempty"`
}

ScansListLast : The URL of the last page of scans.

type ScansListNext 

type ScansListNext struct {
	// The URL of the next page of scans.
	Href *string `json:"href,omitempty"`
}

ScansListNext : The URL of the next page of scans.

type ScansListPrevious 

type ScansListPrevious struct {
	// The URL of the previous page of scans.
	Href *string `json:"href,omitempty"`
}

ScansListPrevious : The URL of the previous page of scans.

type ScansSummaryOptions 

type ScansSummaryOptions struct {
	// Your Scan ID.
	ScanID *string `validate:"required,ne="`

	// The profile ID. This can be obtained from the Security and Compliance Center UI by clicking on the profile name. The
	// URL contains the ID.
	ProfileID *string `validate:"required"`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

ScansSummaryOptions : The ScansSummary options.

func (*ScansSummaryOptions) SetHeaders 

func (options *ScansSummaryOptions) SetHeaders(param map[string]string) *ScansSummaryOptions

SetHeaders : Allow user to set Headers

func (*ScansSummaryOptions) SetProfileID 

func (_options *ScansSummaryOptions) SetProfileID(profileID string) *ScansSummaryOptions

SetProfileID : Allow user to set ProfileID

func (*ScansSummaryOptions) SetScanID 

func (_options *ScansSummaryOptions) SetScanID(scanID string) *ScansSummaryOptions

SetScanID : Allow user to set ScanID

func (*ScansSummaryOptions) SetTransactionID 

func (_options *ScansSummaryOptions) SetTransactionID(transactionID string) *ScansSummaryOptions

SetTransactionID : Allow user to set TransactionID

type Scope 

type Scope struct {
	// A unique identifier for your scope.
	ScopeID *string `json:"scope_id,omitempty"`

	// A unique name for your scope.
	ScopeName *string `json:"scope_name,omitempty"`

	// A detailed description of the scope.
	ScopeDescription *string `json:"scope_description,omitempty"`

	// The unique IDs of the collectors that are attached to the scope.
	CollectorIds []string `json:"collector_ids,omitempty"`

	// The unique identifier of the credential.
	CredentialID *string `json:"credential_id,omitempty"`

	// The environment that the scope is targeted to.
	EnvironmentType *string `json:"environment_type,omitempty"`

	// The time that the scope was created in UTC.
	CreatedTime *strfmt.DateTime `json:"created_time,omitempty"`

	// The time that the scope was last modified in UTC.
	ModifiedTime *strfmt.DateTime `json:"modified_time,omitempty"`
}

Scope : Create Scope Response.

type ScopeItem 

type ScopeItem struct {
	// A detailed description of the scope.
	Description *string `json:"description,omitempty"`

	// The user who created the scope.
	CreatedBy *string `json:"created_by,omitempty"`

	// The user who most recently modified the scope.
	ModifiedBy *string `json:"modified_by,omitempty"`

	// An auto-generated unique identifier for the scope.
	ScopeID *string `json:"scope_id,omitempty"`

	// A unique name for your scope.
	Name *string `json:"name,omitempty"`

	// Indicates whether scope is enabled/disabled.
	Enabled *bool `json:"enabled,omitempty"`

	// The environment that the scope is targeted to.
	EnvironmentType *string `json:"environment_type,omitempty"`

	// The time that the scope was created in UTC.
	CreatedTime *strfmt.DateTime `json:"created_time,omitempty"`

	// The time that the scope was last modified in UTC.
	ModifiedTime *strfmt.DateTime `json:"modified_time,omitempty"`

	// The last type of scan that was run on the scope.
	LastScanType *string `json:"last_scan_type,omitempty"`

	// A description of the last scan type.
	LastScanTypeDescription *string `json:"last_scan_type_description,omitempty"`

	// The last time that a scan status for a scope was updated in UTC.
	LastScanStatusUpdatedTime *strfmt.DateTime `json:"last_scan_status_updated_time,omitempty"`

	// The unique IDs of the collectors that are attached to the scope.
	CollectorsID []string `json:"collectors_id,omitempty"`

	// A list of the scans that have been run on the scope.
	Scans []Scan `json:"scans,omitempty"`
}

ScopeItem : Scope.

type ScopesList 

type ScopesList struct {
	// Scopes.
	Scopes []ScopeItem `json:"scopes,omitempty"`
}

ScopesList : Scopes list.

type SummariesList 

type SummariesList struct {
	// The offset of the page.
	Offset *int64 `json:"offset" validate:"required"`

	// The number of scans displayed per page.
	Limit *int64 `json:"limit" validate:"required"`

	// The total number of scans available in the list of summaries.
	TotalCount *int64 `json:"total_count,omitempty"`

	// he URL of the first scan summary.
	First *SummariesListFirst `json:"first,omitempty"`

	// The URL of the last scan summary.
	Last *SummariesListLast `json:"last,omitempty"`

	// The URL of the previous scan summary.
	Previous *SummariesListPrevious `json:"previous,omitempty"`

	// The URL of the previous scan summary.
	Next *SummariesListNext `json:"next,omitempty"`

	// Summaries.
	Summaries []SummaryItem `json:"summaries,omitempty"`
}

SummariesList : A list of scan summaries.

func (*SummariesList) GetNextOffset 

func (resp *SummariesList) GetNextOffset() (*int64, error)

Retrieve the value to be passed to a request to access the next page of results

type SummariesListFirst 

type SummariesListFirst struct {
	// The URL of the first scan summary.
	Href *string `json:"href,omitempty"`
}

SummariesListFirst : he URL of the first scan summary.

type SummariesListLast 

type SummariesListLast struct {
	// The URL of the last scan summary.
	Href *string `json:"href,omitempty"`
}

SummariesListLast : The URL of the last scan summary.

type SummariesListNext 

type SummariesListNext struct {
	// The URL of the next scan summary.
	Href *string `json:"href,omitempty"`
}

SummariesListNext : The URL of the previous scan summary.

type SummariesListPrevious 

type SummariesListPrevious struct {
	// The URL of the previous scan summary.
	Href *string `json:"href,omitempty"`
}

SummariesListPrevious : The URL of the previous scan summary.

type Summary 

type Summary struct {
	// The scan ID.
	ScanID *string `json:"scan_id,omitempty"`

	// The scan discovery ID.
	DiscoverID *string `json:"discover_id,omitempty"`

	// The scan profile ID.
	ProfileID *string `json:"profile_id,omitempty"`

	// The scan profile name.
	ProfileName *string `json:"profile_name,omitempty"`

	// The scan summary scope ID.
	ScopeID *string `json:"scope_id,omitempty"`

	// The list of controls on the scan summary.
	Controls []Control `json:"controls,omitempty"`
}

Summary : A list of scans summary.

type SummaryItem 

type SummaryItem struct {
	// The ID of the scan.
	ScanID *string `json:"scan_id,omitempty"`

	// A system generated name that is the combination of 12 characters in the scope name and 12 characters of a profile
	// name.
	ScanName *string `json:"scan_name,omitempty"`

	// The ID of the scan.
	ScopeID *string `json:"scope_id,omitempty"`

	// The name of the scope.
	ScopeName *string `json:"scope_name,omitempty"`

	// The entity that ran the report.
	ReportRunBy *string `json:"report_run_by,omitempty"`

	// The date and time the scan was run.
	StartTime *strfmt.DateTime `json:"start_time,omitempty"`

	// The date and time the scan completed.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// The status of the collector as it completes a scan.
	Status *string `json:"status,omitempty"`

	// The result of a profile.
	Profile *ProfileResult `json:"profile,omitempty"`

	// The result of a group profile.
	GroupProfiles *GroupProfileResult `json:"group_profiles,omitempty"`
}

SummaryItem : The result of a scan summeries.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.