posturemanagementv2

package
v4.0.3 Latest Latest
Warning

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

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

Documentation

Overview

Package posturemanagementv2 : Operations and models for the PostureManagementV2 service

Index

Constants

View Source
const (
	CollectorStatusActiveConst                        = "active"
	CollectorStatusApprovalRequiredConst              = "approval_required"
	CollectorStatusApprovedDownloadInProgressConst    = "approved_download_in_progress"
	CollectorStatusApprovedInstallInProgressConst     = "approved_install_in_progress"
	CollectorStatusCoreDownloadedConst                = "core_downloaded"
	CollectorStatusInstallInProgressConst             = "install_in_progress"
	CollectorStatusInstallationFailedConst            = "installation_failed"
	CollectorStatusInstalledConst                     = "installed"
	CollectorStatusInstalledAssigningCredentialsConst = "installed_assigning_credentials"
	CollectorStatusInstalledCredentialsRequiredConst  = "installed_credentials_required"
	CollectorStatusReadyToInstallConst                = "ready_to_install"
	CollectorStatusSuspendedConst                     = "suspended"
	CollectorStatusUnableToConnectConst               = "unable_to_connect"
	CollectorStatusWaitingForUpgradeConst             = "waiting_for_upgrade"
)

Constants associated with the Collector.Status property. The status of the collector.

View Source
const (
	CollectorTypeRestrictedConst   = "restricted"
	CollectorTypeUnrestrictedConst = "unrestricted"
)

Constants associated with the Collector.Type property. The type of the collector.

View Source
const (
	CollectorManagedByCustomerConst = "customer"
	CollectorManagedByIBMConst      = "ibm"
)

Constants associated with the Collector.ManagedBy property. The entity that manages the collector.

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. The parameter `managed_by` 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 Red Hat 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 (
	CreateCredentialOptionsTypeAwsCloudConst         = "aws_cloud"
	CreateCredentialOptionsTypeAzureCloudConst       = "azure_cloud"
	CreateCredentialOptionsTypeDatabaseConst         = "database"
	CreateCredentialOptionsTypeIBMCloudConst         = "ibm_cloud"
	CreateCredentialOptionsTypeKerberosWindowsConst  = "kerberos_windows"
	CreateCredentialOptionsTypeMs365Const            = "ms_365"
	CreateCredentialOptionsTypeOpenstackCloudConst   = "openstack_cloud"
	CreateCredentialOptionsTypeUserNamePemConst      = "user_name_pem"
	CreateCredentialOptionsTypeUsernamePasswordConst = "username_password"
)

Constants associated with the CreateCredentialOptions.Type property. The type of credential.

View Source
const (
	CreateCredentialOptionsPurposeDiscoveryCollectionConst                = "discovery_collection"
	CreateCredentialOptionsPurposeDiscoveryCollectionRemediationConst     = "discovery_collection_remediation"
	CreateCredentialOptionsPurposeDiscoveryFactCollectionConst            = "discovery_fact_collection"
	CreateCredentialOptionsPurposeDiscoveryFactCollectionRemediationConst = "discovery_fact_collection_remediation"
	CreateCredentialOptionsPurposeRemediationConst                        = "remediation"
)

Constants associated with the CreateCredentialOptions.Purpose property. The purpose for which the credential is created.

View Source
const (
	CreateScopeOptionsCredentialTypeAwsConst       = "aws"
	CreateScopeOptionsCredentialTypeAzureConst     = "azure"
	CreateScopeOptionsCredentialTypeGcpConst       = "gcp"
	CreateScopeOptionsCredentialTypeHostedConst    = "hosted"
	CreateScopeOptionsCredentialTypeIBMConst       = "ibm"
	CreateScopeOptionsCredentialTypeOnPremiseConst = "on_premise"
	CreateScopeOptionsCredentialTypeOpenstackConst = "openstack"
	CreateScopeOptionsCredentialTypeServicesConst  = "services"
)

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

View Source
const (
	CredentialTypeAwsCloudConst         = "aws_cloud"
	CredentialTypeAzureCloudConst       = "azure_cloud"
	CredentialTypeDatabaseConst         = "database"
	CredentialTypeIBMCloudConst         = "ibm_cloud"
	CredentialTypeKerberosWindowsConst  = "kerberos_windows"
	CredentialTypeMs365Const            = "ms_365"
	CredentialTypeOpenstackCloudConst   = "openstack_cloud"
	CredentialTypeUsernamePasswordConst = "username_password"
)

Constants associated with the Credential.Type property. The credential's type.

View Source
const (
	CredentialPurposeDiscoveryCollectionConst                = "discovery_collection"
	CredentialPurposeDiscoveryCollectionRemediationConst     = "discovery_collection_remediation"
	CredentialPurposeDiscoveryFactCollectionConst            = "discovery_fact_collection"
	CredentialPurposeDiscoveryFactCollectionRemediationConst = "discovery_fact_collection_remediation"
	CredentialPurposeRemediationConst                        = "remediation"
)

Constants associated with the Credential.Purpose property. The purpose for which the credential is created.

View Source
const (
	EventItemTaskTypeDiscoveryConst      = "discovery"
	EventItemTaskTypeFactCollectionConst = "fact_collection"
)

Constants associated with the EventItem.TaskType property. The task type. The task type has two values (fact_collection and discovery).

View Source
const (
	EventItemStatusAbortTaskRequestCompletedConst       = "abort_task_request_completed"
	EventItemStatusAbortTaskRequestFailedConst          = "abort_task_request_failed"
	EventItemStatusAbortTaskRequestReceivedConst        = "abort_task_request_received"
	EventItemStatusCertRegularValidationCompletedConst  = "cert_regular_validation_completed"
	EventItemStatusCertRegularValidationErrorConst      = "cert_regular_validation_error"
	EventItemStatusCertRegularValidationStartedConst    = "cert_regular_validation_started"
	EventItemStatusCertValidationCompletedConst         = "cert_validation_completed"
	EventItemStatusCertValidationErrorConst             = "cert_validation_error"
	EventItemStatusCertValidationStartedConst           = "cert_validation_started"
	EventItemStatusControllerAbortedConst               = "controller_aborted"
	EventItemStatusCveRegularValidationCompletedConst   = "cve_regular_validation_completed"
	EventItemStatusCveRegularValidationErrorConst       = "cve_regular_validation_error"
	EventItemStatusCveRegularValidationStartedConst     = "cve_regular_validation_started"
	EventItemStatusCveValidationCompletedConst          = "cve_validation_completed"
	EventItemStatusCveValidationErrorConst              = "cve_validation_error"
	EventItemStatusCveValidationStartedConst            = "cve_validation_started"
	EventItemStatusDiscoveryCompletedConst              = "discovery_completed"
	EventItemStatusDiscoveryInProgressConst             = "discovery_in_progress"
	EventItemStatusDiscoveryResultPostedNoErrorConst    = "discovery_result_posted_no_error"
	EventItemStatusDiscoveryResultPostedWithErrorConst  = "discovery_result_posted_with_error"
	EventItemStatusEolRegularValidationCompletedConst   = "eol_regular_validation_completed"
	EventItemStatusEolRegularValidationErrorConst       = "eol_regular_validation_error"
	EventItemStatusEolRegularValidationStartedConst     = "eol_regular_validation_started"
	EventItemStatusEolValidationCompletedConst          = "eol_validation_completed"
	EventItemStatusEolValidationErrorConst              = "eol_validation_error"
	EventItemStatusEolValidationStartedConst            = "eol_validation_started"
	EventItemStatusErrorInAbortTaskRequestConst         = "error_in_abort_task_request"
	EventItemStatusErrorInDiscoveryConst                = "error_in_discovery"
	EventItemStatusErrorInFactCollectionConst           = "error_in_fact_collection"
	EventItemStatusErrorInFactValidationConst           = "error_in_fact_validation"
	EventItemStatusErrorInInventoryConst                = "error_in_inventory"
	EventItemStatusErrorInRemediationConst              = "error_in_remediation"
	EventItemStatusErrorInValidationConst               = "error_in_validation"
	EventItemStatusFactCollectionCompletedConst         = "fact_collection_completed"
	EventItemStatusFactCollectionInProgressConst        = "fact_collection_in_progress"
	EventItemStatusFactCollectionStartedConst           = "fact_collection_started"
	EventItemStatusFactValidationCompletedConst         = "fact_validation_completed"
	EventItemStatusFactValidationInProgressConst        = "fact_validation_in_progress"
	EventItemStatusFactValidationStartedConst           = "fact_validation_started"
	EventItemStatusGatewayAbortedConst                  = "gateway_aborted"
	EventItemStatusInventoryCompletedConst              = "inventory_completed"
	EventItemStatusInventoryCompletedWithErrorConst     = "inventory_completed_with_error"
	EventItemStatusInventoryInProgressConst             = "inventory_in_progress"
	EventItemStatusInventoryStartedConst                = "inventory_started"
	EventItemStatusLocationChangeAbortedConst           = "location_change_aborted"
	EventItemStatusNotAcceptedConst                     = "not_accepted"
	EventItemStatusPendingConst                         = "pending"
	EventItemStatusRemediationCompletedConst            = "remediation_completed"
	EventItemStatusRemediationInProgressConst           = "remediation_in_progress"
	EventItemStatusRemediationStartedConst              = "remediation_started"
	EventItemStatusSentToCollectorConst                 = "sent_to_collector"
	EventItemStatusUserAbortedConst                     = "user_aborted"
	EventItemStatusValidationCompletedConst             = "validation_completed"
	EventItemStatusValidationInProgressConst            = "validation_in_progress"
	EventItemStatusValidationResultPostedNoErrorConst   = "validation_result_posted_no_error"
	EventItemStatusValidationResultPostedWithErrorConst = "validation_result_posted_with_error"
	EventItemStatusValidationStartedConst               = "validation_started"
	EventItemStatusWaitingForRefineConst                = "waiting_for_refine"
)

Constants associated with the EventItem.Status property. The status of the event.

View Source
const (
	GetProfileOptionsProfileTypeAuthoredConst     = "authored"
	GetProfileOptionsProfileTypeCustomConst       = "custom"
	GetProfileOptionsProfileTypePredefinedConst   = "predefined"
	GetProfileOptionsProfileTypeProfileGroupConst = "profile_group"
)

Constants associated with the GetProfileOptions.ProfileType property. The profile type name. The name can be authored/custom/predefined for profiles and profile_group for group profiles.

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

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

View Source
const (
	ProfileTypeAuthoredConst      = "authored"
	ProfileTypeCustomConst        = "custom"
	ProfileTypePredefinedConst    = "predefined"
	ProfileTypeTemplateGroupConst = "template_group"
)

Constants associated with the Profile.Type property. The type of profile.

View Source
const (
	ProfileItemTypeCustomConst        = "custom"
	ProfileItemTypePredefinedConst    = "predefined"
	ProfileItemTypeTemplateGroupConst = "template_group"
)

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

View Source
const (
	ProfileResultTypeAuthoredConst            = "authored"
	ProfileResultTypeCustomConst              = "custom"
	ProfileResultTypePredefinedConst          = "predefined"
	ProfileResultTypeStandardConst            = "standard"
	ProfileResultTypeStandardCertificateConst = "standard_certificate"
	ProfileResultTypeStandardCvConst          = "standard_cv"
	ProfileResultTypeTemmplategroupConst      = "temmplategroup"
)

Constants associated with the ProfileResult.Type 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 (
	ResourceResultStatusPassConst            = "pass"
	ResourceResultStatusUnableToPerformConst = "unable_to_perform"
)

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

View Source
const (
	ScopeStatusAbortTaskRequestCompletedConst       = "abort_task_request_completed"
	ScopeStatusAbortTaskRequestFailedConst          = "abort_task_request_failed"
	ScopeStatusAbortTaskRequestReceivedConst        = "abort_task_request_received"
	ScopeStatusCertRegularValidationCompletedConst  = "cert_regular_validation_completed"
	ScopeStatusCertRegularValidationErrorConst      = "cert_regular_validation_error"
	ScopeStatusCertRegularValidationStartedConst    = "cert_regular_validation_started"
	ScopeStatusCertValidationCompletedConst         = "cert_validation_completed"
	ScopeStatusCertValidationErrorConst             = "cert_validation_error"
	ScopeStatusCertValidationStartedConst           = "cert_validation_started"
	ScopeStatusControllerAbortedConst               = "controller_aborted"
	ScopeStatusCveRegularValidationCompletedConst   = "cve_regular_validation_completed"
	ScopeStatusCveRegularValidationErrorConst       = "cve_regular_validation_error"
	ScopeStatusCveRegularValidationStartedConst     = "cve_regular_validation_started"
	ScopeStatusCveValidationCompletedConst          = "cve_validation_completed"
	ScopeStatusCveValidationErrorConst              = "cve_validation_error"
	ScopeStatusCveValidationStartedConst            = "cve_validation_started"
	ScopeStatusDiscoveryCompletedConst              = "discovery_completed"
	ScopeStatusDiscoveryInProgressConst             = "discovery_in_progress"
	ScopeStatusDiscoveryResultPostedNoErrorConst    = "discovery_result_posted_no_error"
	ScopeStatusDiscoveryResultPostedWithErrorConst  = "discovery_result_posted_with_error"
	ScopeStatusDiscoveryStartedConst                = "discovery_started"
	ScopeStatusEolRegularValidationCompletedConst   = "eol_regular_validation_completed"
	ScopeStatusEolRegularValidationErrorConst       = "eol_regular_validation_error"
	ScopeStatusEolRegularValidationStartedConst     = "eol_regular_validation_started"
	ScopeStatusEolValidationCompletedConst          = "eol_validation_completed"
	ScopeStatusEolValidationErrorConst              = "eol_validation_error"
	ScopeStatusEolValidationStartedConst            = "eol_validation_started"
	ScopeStatusErrorInAbortTaskRequestConst         = "error_in_abort_task_request"
	ScopeStatusErrorInDiscoverConst                 = "error_in_discover"
	ScopeStatusErrorInFactCollectionConst           = "error_in_fact_collection"
	ScopeStatusErrorInFactValidationConst           = "error_in_fact_validation"
	ScopeStatusErrorInInventoryConst                = "error_in_inventory"
	ScopeStatusErrorInRemediationConst              = "error_in_remediation"
	ScopeStatusErrorInValidationConst               = "error_in_validation"
	ScopeStatusFactCollectionCompletedConst         = "fact_collection_completed"
	ScopeStatusFactCollectionInProgressConst        = "fact_collection_in_progress"
	ScopeStatusFactCollectionStartedConst           = "fact_collection_started"
	ScopeStatusFactValidationCompletedConst         = "fact_validation_completed"
	ScopeStatusFactValidationInProgressConst        = "fact_validation_in_progress"
	ScopeStatusFactValidationStartedConst           = "fact_validation_started"
	ScopeStatusGatewayAbortedConst                  = "gateway_aborted"
	ScopeStatusInventoryCompletedConst              = "inventory_completed"
	ScopeStatusInventoryCompletedWithErrorConst     = "inventory_completed_with_error"
	ScopeStatusInventoryInProgressConst             = "inventory_in_progress"
	ScopeStatusInventoryStartedConst                = "inventory_started"
	ScopeStatusLocationChangeAbortedConst           = "location_change_aborted"
	ScopeStatusNotAcceptedConst                     = "not_accepted"
	ScopeStatusPendingConst                         = "pending"
	ScopeStatusRemediationCompletedConst            = "remediation_completed"
	ScopeStatusRemediationInProgressConst           = "remediation_in_progress"
	ScopeStatusRemediationStartedConst              = "remediation_started"
	ScopeStatusSentToCollectorConst                 = "sent_to_collector"
	ScopeStatusUserAbortedConst                     = "user_aborted"
	ScopeStatusValidationCompletedConst             = "validation_completed"
	ScopeStatusValidationInProgressConst            = "validation_in_progress"
	ScopeStatusValidationResultPostedNoErrorConst   = "validation_result_posted_no_error"
	ScopeStatusValidationResultPostedWithErrorConst = "validation_result_posted_with_error"
	ScopeStatusValidationStartedConst               = "validation_started"
	ScopeStatusWaitingForRefineConst                = "waiting_for_refine"
)

Constants associated with the Scope.Status property. The status of the scope. The status is displayed only when the value exists.

View Source
const (
	ScopeTaskTypeAborttasksConst            = "aborttasks"
	ScopeTaskTypeCertRegularValidationConst = "cert_regular_validation"
	ScopeTaskTypeCertValidationConst        = "cert_validation"
	ScopeTaskTypeCveRegularValidationConst  = "cve_regular_validation"
	ScopeTaskTypeCveValidationConst         = "cve_validation"
	ScopeTaskTypeDiscoverConst              = "discover"
	ScopeTaskTypeEolRegularValidationConst  = "eol_regular_validation"
	ScopeTaskTypeEolValidationConst         = "eol_validation"
	ScopeTaskTypeEvidenceConst              = "evidence"
	ScopeTaskTypeFactcollectionConst        = "factcollection"
	ScopeTaskTypeFactvalidationConst        = "factvalidation"
	ScopeTaskTypeInventoryConst             = "inventory"
	ScopeTaskTypeNopConst                   = "nop"
	ScopeTaskTypeRemediationConst           = "remediation"
	ScopeTaskTypeScriptConst                = "script"
	ScopeTaskTypeSubsetvalidateConst        = "subsetvalidate"
	ScopeTaskTypeTldiscoverConst            = "tldiscover"
)

Constants associated with the Scope.TaskType property. The task type of the scope. The task type is displayed only when the value exists.

View Source
const (
	ScopeTypeInventoryConst  = "inventory"
	ScopeTypeValidationConst = "validation"
)

Constants associated with the Scope.Type property. The type of the scope. The type is displayed only when the value exists.

View Source
const (
	ScopeDetailsGatewayTaskTaskTaskTypeAborttasksConst            = "aborttasks"
	ScopeDetailsGatewayTaskTaskTaskTypeCertRegularValidationConst = "cert_regular_validation"
	ScopeDetailsGatewayTaskTaskTaskTypeCertValidationConst        = "cert_validation"
	ScopeDetailsGatewayTaskTaskTaskTypeCveRegularValidationConst  = "cve_regular_validation"
	ScopeDetailsGatewayTaskTaskTaskTypeCveValidationConst         = "cve_validation"
	ScopeDetailsGatewayTaskTaskTaskTypeDiscoverConst              = "discover"
	ScopeDetailsGatewayTaskTaskTaskTypeEolRegularValidationConst  = "eol_regular_validation"
	ScopeDetailsGatewayTaskTaskTaskTypeEolValidationConst         = "eol_validation"
	ScopeDetailsGatewayTaskTaskTaskTypeEvidenceConst              = "evidence"
	ScopeDetailsGatewayTaskTaskTaskTypeFactcollectionConst        = "factcollection"
	ScopeDetailsGatewayTaskTaskTaskTypeFactvalidationConst        = "factvalidation"
	ScopeDetailsGatewayTaskTaskTaskTypeInventoryConst             = "inventory"
	ScopeDetailsGatewayTaskTaskTaskTypeNopConst                   = "nop"
	ScopeDetailsGatewayTaskTaskTaskTypeRemediationConst           = "remediation"
	ScopeDetailsGatewayTaskTaskTaskTypeScriptConst                = "script"
	ScopeDetailsGatewayTaskTaskTaskTypeSubsetvalidateConst        = "subsetvalidate"
	ScopeDetailsGatewayTaskTaskTaskTypeTldiscoverConst            = "tldiscover"
)

Constants associated with the ScopeDetailsGatewayTask.TaskTaskType property. The task type of the scope.

View Source
const (
	ScopeDetailsGatewayTaskTaskStatusAbortTaskRequestCompletedConst       = "abort_task_request_completed"
	ScopeDetailsGatewayTaskTaskStatusAbortTaskRequestFailedConst          = "abort_task_request_failed"
	ScopeDetailsGatewayTaskTaskStatusAbortTaskRequestReceivedConst        = "abort_task_request_received"
	ScopeDetailsGatewayTaskTaskStatusCertRegularValidationCompletedConst  = "cert_regular_validation_completed"
	ScopeDetailsGatewayTaskTaskStatusCertRegularValidationErrorConst      = "cert_regular_validation_error"
	ScopeDetailsGatewayTaskTaskStatusCertRegularValidationStartedConst    = "cert_regular_validation_started"
	ScopeDetailsGatewayTaskTaskStatusCertValidationCompletedConst         = "cert_validation_completed"
	ScopeDetailsGatewayTaskTaskStatusCertValidationErrorConst             = "cert_validation_error"
	ScopeDetailsGatewayTaskTaskStatusCertValidationStartedConst           = "cert_validation_started"
	ScopeDetailsGatewayTaskTaskStatusControllerAbortedConst               = "controller_aborted"
	ScopeDetailsGatewayTaskTaskStatusCveRegularValidationCompletedConst   = "cve_regular_validation_completed"
	ScopeDetailsGatewayTaskTaskStatusCveRegularValidationErrorConst       = "cve_regular_validation_error"
	ScopeDetailsGatewayTaskTaskStatusCveRegularValidationStartedConst     = "cve_regular_validation_started"
	ScopeDetailsGatewayTaskTaskStatusCveValidationCompletedConst          = "cve_validation_completed"
	ScopeDetailsGatewayTaskTaskStatusCveValidationErrorConst              = "cve_validation_error"
	ScopeDetailsGatewayTaskTaskStatusCveValidationStartedConst            = "cve_validation_started"
	ScopeDetailsGatewayTaskTaskStatusDiscoveryCompletedConst              = "discovery_completed"
	ScopeDetailsGatewayTaskTaskStatusDiscoveryInProgressConst             = "discovery_in_progress"
	ScopeDetailsGatewayTaskTaskStatusDiscoveryResultPostedNoErrorConst    = "discovery_result_posted_no_error"
	ScopeDetailsGatewayTaskTaskStatusDiscoveryResultPostedWithErrorConst  = "discovery_result_posted_with_error"
	ScopeDetailsGatewayTaskTaskStatusDiscoveryStartedConst                = "discovery_started"
	ScopeDetailsGatewayTaskTaskStatusEolRegularValidationCompletedConst   = "eol_regular_validation_completed"
	ScopeDetailsGatewayTaskTaskStatusEolRegularValidationErrorConst       = "eol_regular_validation_error"
	ScopeDetailsGatewayTaskTaskStatusEolRegularValidationStartedConst     = "eol_regular_validation_started"
	ScopeDetailsGatewayTaskTaskStatusEolValidationCompletedConst          = "eol_validation_completed"
	ScopeDetailsGatewayTaskTaskStatusEolValidationErrorConst              = "eol_validation_error"
	ScopeDetailsGatewayTaskTaskStatusEolValidationStartedConst            = "eol_validation_started"
	ScopeDetailsGatewayTaskTaskStatusErrorInAbortTaskRequestConst         = "error_in_abort_task_request"
	ScopeDetailsGatewayTaskTaskStatusErrorInDiscoverConst                 = "error_in_discover"
	ScopeDetailsGatewayTaskTaskStatusErrorInFactCollectionConst           = "error_in_fact_collection"
	ScopeDetailsGatewayTaskTaskStatusErrorInFactValidationConst           = "error_in_fact_validation"
	ScopeDetailsGatewayTaskTaskStatusErrorInInventoryConst                = "error_in_inventory"
	ScopeDetailsGatewayTaskTaskStatusErrorInRemediationConst              = "error_in_remediation"
	ScopeDetailsGatewayTaskTaskStatusErrorInValidationConst               = "error_in_validation"
	ScopeDetailsGatewayTaskTaskStatusFactCollectionCompletedConst         = "fact_collection_completed"
	ScopeDetailsGatewayTaskTaskStatusFactCollectionInProgressConst        = "fact_collection_in_progress"
	ScopeDetailsGatewayTaskTaskStatusFactCollectionStartedConst           = "fact_collection_started"
	ScopeDetailsGatewayTaskTaskStatusFactValidationCompletedConst         = "fact_validation_completed"
	ScopeDetailsGatewayTaskTaskStatusFactValidationInProgressConst        = "fact_validation_in_progress"
	ScopeDetailsGatewayTaskTaskStatusFactValidationStartedConst           = "fact_validation_started"
	ScopeDetailsGatewayTaskTaskStatusGatewayAbortedConst                  = "gateway_aborted"
	ScopeDetailsGatewayTaskTaskStatusInventoryCompletedConst              = "inventory_completed"
	ScopeDetailsGatewayTaskTaskStatusInventoryCompletedWithErrorConst     = "inventory_completed_with_error"
	ScopeDetailsGatewayTaskTaskStatusInventoryInProgressConst             = "inventory_in_progress"
	ScopeDetailsGatewayTaskTaskStatusInventoryStartedConst                = "inventory_started"
	ScopeDetailsGatewayTaskTaskStatusLocationChangeAbortedConst           = "location_change_aborted"
	ScopeDetailsGatewayTaskTaskStatusNotAcceptedConst                     = "not_accepted"
	ScopeDetailsGatewayTaskTaskStatusPendingConst                         = "pending"
	ScopeDetailsGatewayTaskTaskStatusRemediationCompletedConst            = "remediation_completed"
	ScopeDetailsGatewayTaskTaskStatusRemediationInProgressConst           = "remediation_in_progress"
	ScopeDetailsGatewayTaskTaskStatusRemediationStartedConst              = "remediation_started"
	ScopeDetailsGatewayTaskTaskStatusSentToCollectorConst                 = "sent_to_collector"
	ScopeDetailsGatewayTaskTaskStatusUserAbortedConst                     = "user_aborted"
	ScopeDetailsGatewayTaskTaskStatusValidationCompletedConst             = "validation_completed"
	ScopeDetailsGatewayTaskTaskStatusValidationInProgressConst            = "validation_in_progress"
	ScopeDetailsGatewayTaskTaskStatusValidationResultPostedNoErrorConst   = "validation_result_posted_no_error"
	ScopeDetailsGatewayTaskTaskStatusValidationResultPostedWithErrorConst = "validation_result_posted_with_error"
	ScopeDetailsGatewayTaskTaskStatusValidationStartedConst               = "validation_started"
	ScopeDetailsGatewayTaskTaskStatusWaitingForRefineConst                = "waiting_for_refine"
)

Constants associated with the ScopeDetailsGatewayTask.TaskStatus property. The task status of the scope.

View Source
const (
	ScopeDetailsGatewayTaskTaskDerivedStatusAbortTaskRequestCompletedConst       = "abort_task_request_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusAbortTaskRequestFailedConst          = "abort_task_request_failed"
	ScopeDetailsGatewayTaskTaskDerivedStatusAbortTaskRequestReceivedConst        = "abort_task_request_received"
	ScopeDetailsGatewayTaskTaskDerivedStatusCertRegularValidationCompletedConst  = "cert_regular_validation_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusCertRegularValidationErrorConst      = "cert_regular_validation_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusCertRegularValidationStartedConst    = "cert_regular_validation_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusCertValidationCompletedConst         = "cert_validation_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusCertValidationErrorConst             = "cert_validation_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusCertValidationStartedConst           = "cert_validation_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusControllerAbortedConst               = "controller_aborted"
	ScopeDetailsGatewayTaskTaskDerivedStatusCveRegularValidationCompletedConst   = "cve_regular_validation_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusCveRegularValidationErrorConst       = "cve_regular_validation_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusCveRegularValidationStartedConst     = "cve_regular_validation_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusCveValidationCompletedConst          = "cve_validation_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusCveValidationErrorConst              = "cve_validation_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusCveValidationStartedConst            = "cve_validation_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusDiscoveryCompletedConst              = "discovery_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusDiscoveryInProgressConst             = "discovery_in_progress"
	ScopeDetailsGatewayTaskTaskDerivedStatusDiscoveryResultPostedNoErrorConst    = "discovery_result_posted_no_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusDiscoveryResultPostedWithErrorConst  = "discovery_result_posted_with_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusDiscoveryStartedConst                = "discovery_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusEolRegularValidationCompletedConst   = "eol_regular_validation_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusEolRegularValidationErrorConst       = "eol_regular_validation_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusEolRegularValidationStartedConst     = "eol_regular_validation_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusEolValidationCompletedConst          = "eol_validation_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusEolValidationErrorConst              = "eol_validation_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusEolValidationStartedConst            = "eol_validation_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusErrorInAbortTaskRequestConst         = "error_in_abort_task_request"
	ScopeDetailsGatewayTaskTaskDerivedStatusErrorInDiscoverConst                 = "error_in_discover"
	ScopeDetailsGatewayTaskTaskDerivedStatusErrorInFactCollectionConst           = "error_in_fact_collection"
	ScopeDetailsGatewayTaskTaskDerivedStatusErrorInFactValidationConst           = "error_in_fact_validation"
	ScopeDetailsGatewayTaskTaskDerivedStatusErrorInInventoryConst                = "error_in_inventory"
	ScopeDetailsGatewayTaskTaskDerivedStatusErrorInRemediationConst              = "error_in_remediation"
	ScopeDetailsGatewayTaskTaskDerivedStatusErrorInValidationConst               = "error_in_validation"
	ScopeDetailsGatewayTaskTaskDerivedStatusFactCollectionCompletedConst         = "fact_collection_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusFactCollectionInProgressConst        = "fact_collection_in_progress"
	ScopeDetailsGatewayTaskTaskDerivedStatusFactCollectionStartedConst           = "fact_collection_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusFactValidationCompletedConst         = "fact_validation_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusFactValidationInProgressConst        = "fact_validation_in_progress"
	ScopeDetailsGatewayTaskTaskDerivedStatusFactValidationStartedConst           = "fact_validation_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusGatewayAbortedConst                  = "gateway_aborted"
	ScopeDetailsGatewayTaskTaskDerivedStatusInventoryCompletedConst              = "inventory_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusInventoryCompletedWithErrorConst     = "inventory_completed_with_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusInventoryInProgressConst             = "inventory_in_progress"
	ScopeDetailsGatewayTaskTaskDerivedStatusInventoryStartedConst                = "inventory_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusLocationChangeAbortedConst           = "location_change_aborted"
	ScopeDetailsGatewayTaskTaskDerivedStatusNotAcceptedConst                     = "not_accepted"
	ScopeDetailsGatewayTaskTaskDerivedStatusPendingConst                         = "pending"
	ScopeDetailsGatewayTaskTaskDerivedStatusRemediationCompletedConst            = "remediation_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusRemediationInProgressConst           = "remediation_in_progress"
	ScopeDetailsGatewayTaskTaskDerivedStatusRemediationStartedConst              = "remediation_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusSentToCollectorConst                 = "sent_to_collector"
	ScopeDetailsGatewayTaskTaskDerivedStatusUserAbortedConst                     = "user_aborted"
	ScopeDetailsGatewayTaskTaskDerivedStatusValidationCompletedConst             = "validation_completed"
	ScopeDetailsGatewayTaskTaskDerivedStatusValidationInProgressConst            = "validation_in_progress"
	ScopeDetailsGatewayTaskTaskDerivedStatusValidationResultPostedNoErrorConst   = "validation_result_posted_no_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusValidationResultPostedWithErrorConst = "validation_result_posted_with_error"
	ScopeDetailsGatewayTaskTaskDerivedStatusValidationStartedConst               = "validation_started"
	ScopeDetailsGatewayTaskTaskDerivedStatusWaitingForRefineConst                = "waiting_for_refine"
)

Constants associated with the ScopeDetailsGatewayTask.TaskDerivedStatus property. The task derived status of the scope.

View Source
const (
	ScopeItemCredentialTypeAwsConst       = "aws"
	ScopeItemCredentialTypeAzureConst     = "azure"
	ScopeItemCredentialTypeGcpConst       = "gcp"
	ScopeItemCredentialTypeHostedConst    = "hosted"
	ScopeItemCredentialTypeIBMConst       = "ibm"
	ScopeItemCredentialTypeOnPremiseConst = "on_premise"
	ScopeItemCredentialTypeOpenstackConst = "openstack"
	ScopeItemCredentialTypeServicesConst  = "services"
)

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

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 (
	UpdateCredentialOptionsTypeAwsCloudConst         = "aws_cloud"
	UpdateCredentialOptionsTypeAzureCloudConst       = "azure_cloud"
	UpdateCredentialOptionsTypeDatabaseConst         = "database"
	UpdateCredentialOptionsTypeIBMCloudConst         = "ibm_cloud"
	UpdateCredentialOptionsTypeKerberosWindowsConst  = "kerberos_windows"
	UpdateCredentialOptionsTypeMs365Const            = "ms_365"
	UpdateCredentialOptionsTypeOpenstackCloudConst   = "openstack_cloud"
	UpdateCredentialOptionsTypeUserNamePemConst      = "user_name_pem"
	UpdateCredentialOptionsTypeUsernamePasswordConst = "username_password"
)

Constants associated with the UpdateCredentialOptions.Type property. The credential's type.

View Source
const (
	UpdateCredentialOptionsPurposeDiscoveryCollectionConst                = "discovery_collection"
	UpdateCredentialOptionsPurposeDiscoveryCollectionRemediationConst     = "discovery_collection_remediation"
	UpdateCredentialOptionsPurposeDiscoveryFactCollectionConst            = "discovery_fact_collection"
	UpdateCredentialOptionsPurposeDiscoveryFactCollectionRemediationConst = "discovery_fact_collection_remediation"
	UpdateCredentialOptionsPurposeRemediationConst                        = "remediation"
)

Constants associated with the UpdateCredentialOptions.Purpose property. The purpose for which the credential is created.

View Source
const (
	UpdateProfilesOptionsTypeCustomConst     = "custom"
	UpdateProfilesOptionsTypePredefinedConst = "predefined"
)

Constants associated with the UpdateProfilesOptions.Type property. The type of profile. Seed profiles have the type set as 'predefined' and user-generated profiles have the type set as 'custom'.

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"
View Source
const (
	ScopeSubCategoriesByTypeMs365Const = "ms_365"
)

Constants associated with the Scope.SubCategoriesByType property. The sub categories by type of the scope. The categories are displayed only when the values exist.

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 UnmarshalBasicResult

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

UnmarshalBasicResult unmarshals an instance of BasicResult 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 UnmarshalCollectorList

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

UnmarshalCollectorList unmarshals an instance of CollectorList from the specified map of raw messages.

func UnmarshalCollectorUpdate

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

UnmarshalCollectorUpdate unmarshals an instance of CollectorUpdate 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 UnmarshalControlItem

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

UnmarshalControlItem unmarshals an instance of ControlItem from the specified map of raw messages.

func UnmarshalControlList

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

UnmarshalControlList unmarshals an instance of ControlList 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 UnmarshalCredentialDisplayFields

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

UnmarshalCredentialDisplayFields unmarshals an instance of CredentialDisplayFields from the specified map of raw messages.

func UnmarshalCredentialList

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

UnmarshalCredentialList unmarshals an instance of CredentialList from the specified map of raw messages.

func UnmarshalEventItem

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

UnmarshalEventItem unmarshals an instance of EventItem from the specified map of raw messages.

func UnmarshalEventList

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

UnmarshalEventList unmarshals an instance of EventList 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 UnmarshalGoalItem

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

UnmarshalGoalItem unmarshals an instance of GoalItem from the specified map of raw messages.

func UnmarshalNewCredentialDisplayFields

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

UnmarshalNewCredentialDisplayFields unmarshals an instance of NewCredentialDisplayFields from the specified map of raw messages.

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

UnmarshalPageLink unmarshals an instance of PageLink from the specified map of raw messages.

func UnmarshalProfile

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

UnmarshalProfile unmarshals an instance of Profile 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 UnmarshalProfileList

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

UnmarshalProfileList unmarshals an instance of ProfileList 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 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 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 UnmarshalScanList

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

UnmarshalScanList unmarshals an instance of ScanList 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 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 UnmarshalScopeCollector

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

UnmarshalScopeCollector unmarshals an instance of ScopeCollector from the specified map of raw messages.

func UnmarshalScopeCredential

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

UnmarshalScopeCredential unmarshals an instance of ScopeCredential from the specified map of raw messages.

func UnmarshalScopeDetailsAssetData

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

UnmarshalScopeDetailsAssetData unmarshals an instance of ScopeDetailsAssetData from the specified map of raw messages.

func UnmarshalScopeDetailsCredential

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

UnmarshalScopeDetailsCredential unmarshals an instance of ScopeDetailsCredential from the specified map of raw messages.

func UnmarshalScopeDetailsCredentialDisplayFields

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

UnmarshalScopeDetailsCredentialDisplayFields unmarshals an instance of ScopeDetailsCredentialDisplayFields from the specified map of raw messages.

func UnmarshalScopeDetailsGatewayTask

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

UnmarshalScopeDetailsGatewayTask unmarshals an instance of ScopeDetailsGatewayTask 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 UnmarshalScopeList

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

UnmarshalScopeList unmarshals an instance of ScopeList from the specified map of raw messages.

func UnmarshalScopeTaskStatus

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

UnmarshalScopeTaskStatus unmarshals an instance of ScopeTaskStatus 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.

func UnmarshalSummaryList

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

UnmarshalSummaryList unmarshals an instance of SummaryList from the specified map of raw messages.

func UnmarshalTaskLogs

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

UnmarshalTaskLogs unmarshals an instance of TaskLogs from the specified map of raw messages.

func UnmarshalUpdateCredentialDisplayFields

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

UnmarshalUpdateCredentialDisplayFields unmarshals an instance of UpdateCredentialDisplayFields 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 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"`
}

ApplicabilityCriteria : The criteria that defines how a profile applies.

type BasicResult

type BasicResult struct {
	// A message.
	Message *string `json:"message" validate:"required"`

	// The result of the operation.
	Result *bool `json:"result" validate:"required"`

	// Id of created Profile.
	ProfileID *string `json:"profile_id,omitempty"`
}

BasicResult : A basic response.

type Collector

type Collector struct {
	// The ID of the collector.
	ID *string `json:"id" validate:"required"`

	// The user-friendly name of the collector.
	DisplayName *string `json:"display_name" validate:"required"`

	// The name of the collector.
	Name *string `json:"name" validate:"required"`

	// The public key of the collector. The key is used for SSL communication between collector and orchestrator. This
	// property is populated when the collector is installed.
	PublicKey *string `json:"public_key,omitempty"`

	// The heartbeat time of the controller. This value exists when the collector is installed and running.
	LastHeartbeat *strfmt.DateTime `json:"last_heartbeat,omitempty"`

	// The status of the collector.
	Status *string `json:"status" validate:"required"`

	// The collector version. This field is populated when the collector is installed.
	CollectorVersion *string `json:"collector_version,omitempty"`

	// The image version of the collector. This field is populated when the collector is installed.".
	ImageVersion *string `json:"image_version,omitempty"`

	// The description of the collector.
	Description *string `json:"description" validate:"required"`

	// The ID of the user that created the collector.
	CreatedBy *string `json:"created_by" validate:"required"`

	// The ISO date and time when the collector was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The ID of the user that modified the collector.
	UpdatedBy *string `json:"updated_by" validate:"required"`

	// The ISO date and time when the collector was modified.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// The indication of whether the collector is enabled or not(deleted).
	Enabled *bool `json:"enabled" validate:"required"`

	// The registration code of the collector. The code is used for initial authentication during the installation of the
	// collector.
	RegistrationCode *string `json:"registration_code" validate:"required"`

	// The type of the collector.
	Type *string `json:"type" validate:"required"`

	// The credential's public key.
	CredentialPublicKey *string `json:"credential_public_key,omitempty"`

	// The number of times that the collector failed.
	FailureCount *int64 `json:"failure_count" validate:"required"`

	// The approved local gateway IP of the collector. The IP is populated only when the collector is installed.
	ApprovedLocalGatewayIP *string `json:"approved_local_gateway_ip,omitempty"`

	// The approved internet gateway IP of the collector. The IP is populated only when the collector is installed.
	ApprovedInternetGatewayIP *string `json:"approved_internet_gateway_ip,omitempty"`

	// The failed local gateway IP. The IP is populated only when the collector is installed.
	LastFailedLocalGatewayIP *string `json:"last_failed_local_gateway_ip,omitempty"`

	// The reason for the collector reset. User resets the collector with a reason for reset. The reason that is entered by
	// the user is saved in this field .
	ResetReason *string `json:"reset_reason,omitempty"`

	// The collector hostname. The hostname is populated when the collector is installed. The fully qualified domain name
	// is included.
	Hostname *string `json:"hostname,omitempty"`

	// The installation path of the collector. This field is populated when the collector is installed. The value includes
	// the folder path.
	InstallPath *string `json:"install_path,omitempty"`

	// The indication of whether the collector uses a public or private endpoint. This value is generated based on the
	// `is_public` field value during collector creation. If `is_public` is set to true, the `use_private_endpoint` value
	// is false.
	UsePrivateEndpoint *bool `json:"use_private_endpoint" validate:"required"`

	// The entity that manages the collector.
	ManagedBy *string `json:"managed_by" validate:"required"`

	// The trial expiry indicates the expiry date of `registration_code`. This field is populated when the collector is
	// installed.
	TrialExpiry *strfmt.DateTime `json:"trial_expiry,omitempty"`

	// The failed internet gateway IP of the collector.
	LastFailedInternetGatewayIP *string `json:"last_failed_internet_gateway_ip,omitempty"`

	// The collector status.
	StatusDescription *string `json:"status_description" validate:"required"`

	// The ISO date and time of the collector reset. This value is populated when a collector is reset. The data-time when
	// the reset event occurs is captured in this field.
	ResetTime *strfmt.DateTime `json:"reset_time,omitempty"`

	// An indication of 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 `json:"is_public" validate:"required"`

	// An indication of whether the collector has a UBI image.
	IsUbiImage *bool `json:"is_ubi_image,omitempty"`
}

Collector : The details of a collector.

type CollectorList

type CollectorList struct {
	// The offset from the start of the list (0-based).
	Offset *int64 `json:"offset" validate:"required"`

	// The number of items that are returned.
	Limit *int64 `json:"limit" validate:"required"`

	// The total number of items that are in the list. The field's value is 0 when no collectors are available and the
	// details are not populated in that case.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The URL of a page.
	First *PageLink `json:"first" validate:"required"`

	// The URL of a page.
	Last *PageLink `json:"last" validate:"required"`

	// The URL of a page.
	Next *PageLink `json:"next,omitempty"`

	// The URL of a page.
	Previous *PageLink `json:"previous,omitempty"`

	// The array of items that are returned.
	Collectors []Collector `json:"collectors" validate:"required"`
}

CollectorList : The response to a request to list collectors.

type CollectorUpdate

type CollectorUpdate struct {
	// The display name of the collector.
	DisplayName *string `json:"display_name,omitempty"`

	// The description of the collector.
	Description *string `json:"description,omitempty"`
}

CollectorUpdate : The instance of the collector update.

func (*CollectorUpdate) AsPatch

func (collectorUpdate *CollectorUpdate) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the CollectorUpdate

type Control

type Control struct {
	// The scan summary control ID.
	ID *string `json:"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.
	Description *string `json:"description,omitempty"`

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

	// A scan's summary controls.
	ResourceStatistics *ResourceStatistics `json:"resource_statistics,omitempty"`
}

Control : A scan's summary controls.

type ControlItem

type ControlItem struct {
	// The identifier number of the control.
	ID *string `json:"id" validate:"required"`

	// The description of the control.
	Description *string `json:"description" validate:"required"`

	// The external identifier number of the control.
	ExternalControlID *string `json:"external_control_id" validate:"required"`

	// The goals that are mapped against the control identifier.
	Goals []GoalItem `json:"goals" validate:"required"`
}

ControlItem : The details of the profile.

type ControlList

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

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

	// The total number of profiles. If no profiles are available, the count is 0 and the detail fields are not populated.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The URL of a page.
	First *PageLink `json:"first" validate:"required"`

	// The URL of a page.
	Last *PageLink `json:"last" validate:"required"`

	// The URL of a page.
	Previous *PageLink `json:"previous,omitempty"`

	// The URL of a page.
	Next *PageLink `json:"next,omitempty"`

	// Profiles array.
	Controls []ControlItem `json:"controls" validate:"required"`
}

ControlList : The details of the controls for the profile.

func (*ControlList) GetNextOffset

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

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

type CreateCollectorOptions

type CreateCollectorOptions struct {
	// A unique name for your collector.
	Name *string `json:"name" validate:"required"`

	// The parameter `is_public` determines whether the collector endpoint is accessible on a public network. If set to
	// `true`, the collector connects to resources that are in your account over a public network. If set to `false`, the
	// collector connects to your resources by using a private IP that is accessible only through the IBM Cloud private
	// network.
	IsPublic *bool `json:"is_public" validate:"required"`

	// The parameter `managed_by` 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 Red Hat 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 `json:"managed_by" validate:"required"`

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

	// 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 `json:"passphrase,omitempty"`

	// The parameter `is_ubi_image` determines whether the collector has a UBI image.
	IsUbiImage *bool `json:"is_ubi_image,omitempty"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

CreateCollectorOptions : The CreateCollector options.

func (*CreateCollectorOptions) SetAccountID

func (_options *CreateCollectorOptions) SetAccountID(accountID string) *CreateCollectorOptions

SetAccountID : Allow user to set AccountID

func (*CreateCollectorOptions) SetDescription

func (_options *CreateCollectorOptions) SetDescription(description string) *CreateCollectorOptions

SetDescription : Allow user to set Description

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) SetIsUbiImage

func (_options *CreateCollectorOptions) SetIsUbiImage(isUbiImage bool) *CreateCollectorOptions

SetIsUbiImage : Allow user to set IsUbiImage

func (*CreateCollectorOptions) SetManagedBy

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

SetManagedBy : Allow user to set ManagedBy

func (*CreateCollectorOptions) SetName

func (_options *CreateCollectorOptions) SetName(name string) *CreateCollectorOptions

SetName : Allow user to set Name

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 status of credentials is enabled or disabled.
	Enabled *bool `json:"enabled" validate:"required"`

	// The type of credential.
	Type *string `json:"type" validate:"required"`

	// The name of the credential.
	Name *string `json:"name" validate:"required"`

	// The description of the credential.
	Description *string `json:"description" validate:"required"`

	// The details of the credential. The details change as the selected credential type varies.
	DisplayFields *NewCredentialDisplayFields `json:"display_fields" validate:"required"`

	// The purpose for which the credential is created.
	Purpose *string `json:"purpose" validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

CreateCredentialOptions : The CreateCredential options.

func (*CreateCredentialOptions) SetAccountID

func (_options *CreateCredentialOptions) SetAccountID(accountID string) *CreateCredentialOptions

SetAccountID : Allow user to set AccountID

func (*CreateCredentialOptions) SetDescription

func (_options *CreateCredentialOptions) SetDescription(description string) *CreateCredentialOptions

SetDescription : Allow user to set Description

func (*CreateCredentialOptions) SetDisplayFields

func (_options *CreateCredentialOptions) SetDisplayFields(displayFields *NewCredentialDisplayFields) *CreateCredentialOptions

SetDisplayFields : Allow user to set DisplayFields

func (*CreateCredentialOptions) SetEnabled

func (_options *CreateCredentialOptions) SetEnabled(enabled bool) *CreateCredentialOptions

SetEnabled : Allow user to set Enabled

func (*CreateCredentialOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateCredentialOptions) SetName

func (_options *CreateCredentialOptions) SetName(name string) *CreateCredentialOptions

SetName : Allow user to set Name

func (*CreateCredentialOptions) SetPurpose

func (_options *CreateCredentialOptions) SetPurpose(purpose string) *CreateCredentialOptions

SetPurpose : Allow user to set Purpose

func (*CreateCredentialOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

func (*CreateCredentialOptions) SetType

func (_options *CreateCredentialOptions) SetType(typeVar string) *CreateCredentialOptions

SetType : Allow user to set Type

type CreateScopeOptions

type CreateScopeOptions struct {
	// A unique name for your scope.
	Name *string `json:"name" validate:"required"`

	// A detailed description of the scope.
	Description *string `json:"description" validate:"required"`

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

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

	// The environment that the scope is targeted to.
	CredentialType *string `json:"credential_type" validate:"required"`

	// The frequency of the scope. `interval` is used with on-prem scope if the user wants to schedule a discovery task.
	// The unit is seconds. For example, if a user wants to trigger discovery every hour, this value is set to 3600.
	Interval *int64 `json:"interval,omitempty"`

	// The discovery scheduled for the scope. `is_discovery_scheduled` is used with on-prem scope if the user wants to
	// schedule a discovery task.
	IsDiscoveryScheduled *bool `json:"is_discovery_scheduled,omitempty"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

CreateScopeOptions : The CreateScope options.

func (*CreateScopeOptions) SetAccountID

func (_options *CreateScopeOptions) SetAccountID(accountID string) *CreateScopeOptions

SetAccountID : Allow user to set AccountID

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) SetCredentialType

func (_options *CreateScopeOptions) SetCredentialType(credentialType string) *CreateScopeOptions

SetCredentialType : Allow user to set CredentialType

func (*CreateScopeOptions) SetDescription

func (_options *CreateScopeOptions) SetDescription(description string) *CreateScopeOptions

SetDescription : Allow user to set Description

func (*CreateScopeOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateScopeOptions) SetInterval

func (_options *CreateScopeOptions) SetInterval(interval int64) *CreateScopeOptions

SetInterval : Allow user to set Interval

func (*CreateScopeOptions) SetIsDiscoveryScheduled

func (_options *CreateScopeOptions) SetIsDiscoveryScheduled(isDiscoveryScheduled bool) *CreateScopeOptions

SetIsDiscoveryScheduled : Allow user to set IsDiscoveryScheduled

func (*CreateScopeOptions) SetName

func (_options *CreateScopeOptions) SetName(name string) *CreateScopeOptions

SetName : Allow user to set Name

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 `json:"scope_id" validate:"required"`

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

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

	// The name of a scheduled scan.This is mandatory when scheduled scan is initiated.
	Name *string `json:"name,omitempty"`

	// The description of a scheduled scan.
	Description *string `json:"description,omitempty"`

	// The frequency of a scheduled scan in milliseconds.
	Frequency *int64 `json:"frequency,omitempty"`

	// The no_of_occurrences of a scheduled scan.
	NoOfOccurrences *int64 `json:"no_of_occurrences,omitempty"`

	// The end date-time of a scheduled scan in UTC.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

CreateValidationOptions : The CreateValidation options.

func (*CreateValidationOptions) SetAccountID

func (_options *CreateValidationOptions) SetAccountID(accountID string) *CreateValidationOptions

SetAccountID : Allow user to set AccountID

func (*CreateValidationOptions) SetDescription

func (_options *CreateValidationOptions) SetDescription(description string) *CreateValidationOptions

SetDescription : Allow user to set Description

func (*CreateValidationOptions) SetEndTime

func (_options *CreateValidationOptions) SetEndTime(endTime *strfmt.DateTime) *CreateValidationOptions

SetEndTime : Allow user to set EndTime

func (*CreateValidationOptions) SetFrequency

func (_options *CreateValidationOptions) SetFrequency(frequency int64) *CreateValidationOptions

SetFrequency : Allow user to set Frequency

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) SetName

func (_options *CreateValidationOptions) SetName(name string) *CreateValidationOptions

SetName : Allow user to set Name

func (*CreateValidationOptions) SetNoOfOccurrences

func (_options *CreateValidationOptions) SetNoOfOccurrences(noOfOccurrences int64) *CreateValidationOptions

SetNoOfOccurrences : Allow user to set NoOfOccurrences

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 status of the credential is enabled or disabled.
	Enabled *bool `json:"enabled" validate:"required"`

	// The credential's ID.
	ID *string `json:"id" validate:"required"`

	// The credential's type.
	Type *string `json:"type" validate:"required"`

	// The credential's name.
	Name *string `json:"name" validate:"required"`

	// The credential's description.
	Description *string `json:"description" validate:"required"`

	// The details of the credential. The details change as the selected credential type changes.
	DisplayFields *CredentialDisplayFields `json:"display_fields" validate:"required"`

	// The ID of the user who created the credentials.
	CreatedBy *string `json:"created_by" validate:"required"`

	// The time of creation of the credentials in UTC.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The modified time of the credentials in UTC.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// The ID of the user who modified the credentials.
	UpdatedBy *string `json:"updated_by" validate:"required"`

	// The purpose for which the credential is created.
	Purpose *string `json:"purpose" validate:"required"`
}

Credential : Get the credential details.

type CredentialDisplayFields

type CredentialDisplayFields struct {
	// The IBM Cloud API key. The API key is mandatory when IBM is the credential type.
	IBMAPIKey *string `json:"ibm_api_key,omitempty"`

	// The Amazon Web Services client ID. The client ID is mandatory when AWS Cloud is the credential type.
	AwsClientID *string `json:"aws_client_id,omitempty"`

	// The Amazon Web Services client secret. The secret is mandatory when AWS Cloud is the credential type.
	AwsClientSecret *string `json:"aws_client_secret,omitempty"`

	// The Amazon Web Services region. The region is mandatory when AWS Cloud is the credential type.
	AwsRegion *string `json:"aws_region,omitempty"`

	// AWS arn value.
	AwsArn *string `json:"aws_arn,omitempty"`

	// The username of the user. The username is mandatory when the credential type is DataBase, Kerberos, or OpenStack.
	Username *string `json:"username,omitempty"`

	// The password of the user. The password is mandatory when the credential type is DataBase, Kerberos, or OpenStack.
	Password *string `json:"password,omitempty"`

	// The Microsoft Azure client ID. The client ID is mandatory when Azure is the credential type.
	AzureClientID *string `json:"azure_client_id,omitempty"`

	// The Microsoft Azure client secret. The secret is mandatory when Azure is the credential type.
	AzureClientSecret *string `json:"azure_client_secret,omitempty"`

	// The Microsoft Azure subscription ID. The subscription ID is mandatory when Azure is the credential type.
	AzureSubscriptionID *string `json:"azure_subscription_id,omitempty"`

	// The Microsoft Azure resource group. The resource group is mandatory when Azure is the credential type.
	AzureResourceGroup *string `json:"azure_resource_group,omitempty"`

	// The Database name. The name is mandatory when Database is the credential type.
	DatabaseName *string `json:"database_name,omitempty"`

	// The Kerberos Windows auth type. The auth type is mandatory when Kerberos is the credential type.
	WinrmAuthtype *string `json:"winrm_authtype,omitempty"`

	// The Kerberos Windows SSL. The SSL is mandatory when Kerberos is the credential type.
	WinrmUsessl *string `json:"winrm_usessl,omitempty"`

	// The Kerberos Windows port. The port is mandatory when Kerberos is the credential type.
	WinrmPort *string `json:"winrm_port,omitempty"`

	// The Microsoft 365 client ID. The client ID is mandatory when Microsoft 365 is the credential type.
	Ms365ClientID *string `json:"ms_365_client_id,omitempty"`

	// The Microsoft 365 client secret. The secret is mandatory when Microsoft 365 is the credential type.
	Ms365ClientSecret *string `json:"ms_365_client_secret,omitempty"`

	// The Microsoft 365 tenant ID. The tenant ID is mandatory when Microsoft 365 is the credential type.
	Ms365TenantID *string `json:"ms_365_tenant_id,omitempty"`

	// The auth url of the OpenStack cloud. The auth url is mandatory when OpenStack is the credential type.
	AuthURL *string `json:"auth_url,omitempty"`

	// The project name of the OpenStack cloud. The project name is mandatory when OpenStack is the credential type.
	ProjectName *string `json:"project_name,omitempty"`

	// The user domain name of the OpenStack cloud. The domain name is mandatory when OpenStack is the credential type.
	UserDomainName *string `json:"user_domain_name,omitempty"`

	// The project domain name of the OpenStack cloud. The project domain name is mandatory when OpenStack is the
	// credential type.
	ProjectDomainName *string `json:"project_domain_name,omitempty"`

	// The user pem file name.
	PemFileName *string `json:"pem_file_name,omitempty"`

	// The base64 encoded form of pem.Will be displayed a xxxxxx.
	PemData *string `json:"pem_data,omitempty"`
}

CredentialDisplayFields : The details of the credential. The details change as the selected credential type changes.

type CredentialList

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

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

	// The total number of credentials that are in the list. The number is 0 if no credentials are available and the detail
	// fields of the credentials are not populated in that case.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The URL of a page.
	First *PageLink `json:"first" validate:"required"`

	// The URL of a page.
	Last *PageLink `json:"last" validate:"required"`

	// The URL of a page.
	Previous *PageLink `json:"previous,omitempty"`

	// The URL of a page.
	Next *PageLink `json:"next,omitempty"`

	// The details of a credential.
	Credentials []Credential `json:"credentials" validate:"required"`
}

CredentialList : A list of credentials.

func (*CredentialList) GetNextOffset

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

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

type DeleteCollectorOptions

type DeleteCollectorOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

DeleteCollectorOptions : The DeleteCollector options.

func (*DeleteCollectorOptions) SetAccountID

func (_options *DeleteCollectorOptions) SetAccountID(accountID string) *DeleteCollectorOptions

SetAccountID : Allow user to set AccountID

func (*DeleteCollectorOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteCollectorOptions) SetID

SetID : Allow user to set ID

func (*DeleteCollectorOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type DeleteCredentialOptions

type DeleteCredentialOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

DeleteCredentialOptions : The DeleteCredential options.

func (*DeleteCredentialOptions) SetAccountID

func (_options *DeleteCredentialOptions) SetAccountID(accountID string) *DeleteCredentialOptions

SetAccountID : Allow user to set AccountID

func (*DeleteCredentialOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteCredentialOptions) SetID

SetID : Allow user to set ID

func (*DeleteCredentialOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type DeleteProfileOptions

type DeleteProfileOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

DeleteProfileOptions : The DeleteProfile options.

func (*DeleteProfileOptions) SetAccountID

func (_options *DeleteProfileOptions) SetAccountID(accountID string) *DeleteProfileOptions

SetAccountID : Allow user to set AccountID

func (*DeleteProfileOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteProfileOptions) SetID

func (_options *DeleteProfileOptions) SetID(id string) *DeleteProfileOptions

SetID : Allow user to set ID

func (*DeleteProfileOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type DeleteScopeOptions

type DeleteScopeOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

DeleteScopeOptions : The DeleteScope options.

func (*DeleteScopeOptions) SetAccountID

func (_options *DeleteScopeOptions) SetAccountID(accountID string) *DeleteScopeOptions

SetAccountID : Allow user to set AccountID

func (*DeleteScopeOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteScopeOptions) SetID

func (_options *DeleteScopeOptions) SetID(id string) *DeleteScopeOptions

SetID : Allow user to set ID

func (*DeleteScopeOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type EventItem

type EventItem struct {
	// The event ID for the scope.
	ID *string `json:"id" validate:"required"`

	// The time that the event was created in UTC for this scope.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The time that the event was last updated in UTC for this scope.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// The task type. The task type has two values (fact_collection and discovery).
	TaskType *string `json:"task_type" validate:"required"`

	// The status of the event.
	Status *string `json:"status" validate:"required"`

	// Data is available for this event.
	DataAvailable *bool `json:"data_available" validate:"required"`

	// The status of the event.
	StatusMessage *string `json:"status_message" validate:"required"`
}

EventItem : Th event details.

type EventList

type EventList struct {
	// The events for a given scope.
	Events []EventItem `json:"events,omitempty"`
}

EventList : The list of events.

type GetCollectorOptions

type GetCollectorOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

GetCollectorOptions : The GetCollector options.

func (*GetCollectorOptions) SetAccountID

func (_options *GetCollectorOptions) SetAccountID(accountID string) *GetCollectorOptions

SetAccountID : Allow user to set AccountID

func (*GetCollectorOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetCollectorOptions) SetID

func (_options *GetCollectorOptions) SetID(id string) *GetCollectorOptions

SetID : Allow user to set ID

func (*GetCollectorOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type GetCorrelationIDOptions

type GetCorrelationIDOptions struct {
	// Get the status of a task such as discovery or validation. A correlation ID is created when a scope is created and
	// discovery or validation is triggered for a scope.
	CorrelationID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

GetCorrelationIDOptions : The GetCorrelationID options.

func (*GetCorrelationIDOptions) SetAccountID

func (_options *GetCorrelationIDOptions) SetAccountID(accountID string) *GetCorrelationIDOptions

SetAccountID : Allow user to set AccountID

func (*GetCorrelationIDOptions) SetCorrelationID

func (_options *GetCorrelationIDOptions) SetCorrelationID(correlationID string) *GetCorrelationIDOptions

SetCorrelationID : Allow user to set CorrelationID

func (*GetCorrelationIDOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetCorrelationIDOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type GetCredentialOptions

type GetCredentialOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

GetCredentialOptions : The GetCredential options.

func (*GetCredentialOptions) SetAccountID

func (_options *GetCredentialOptions) SetAccountID(accountID string) *GetCredentialOptions

SetAccountID : Allow user to set AccountID

func (*GetCredentialOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetCredentialOptions) SetID

func (_options *GetCredentialOptions) SetID(id string) *GetCredentialOptions

SetID : Allow user to set ID

func (*GetCredentialOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type GetGroupProfileControlsOptions

type GetGroupProfileControlsOptions struct {
	// The group ID. The ID can be obtained from the profile list API call. In the profile list API call, the records that
	// have type='profile_group' are the groups. The ID of that object displays group_id.
	GroupID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

	// The offset of the profiles.
	Offset *int64 `json:"-"`

	// The number of profiles that are included per page.
	Limit *int64 `json:"-"`

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

GetGroupProfileControlsOptions : The GetGroupProfileControls options.

func (*GetGroupProfileControlsOptions) SetAccountID

func (_options *GetGroupProfileControlsOptions) SetAccountID(accountID string) *GetGroupProfileControlsOptions

SetAccountID : Allow user to set AccountID

func (*GetGroupProfileControlsOptions) SetGroupID

SetGroupID : Allow user to set GroupID

func (*GetGroupProfileControlsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*GetGroupProfileControlsOptions) SetLimit

SetLimit : Allow user to set Limit

func (*GetGroupProfileControlsOptions) SetOffset

SetOffset : Allow user to set Offset

func (*GetGroupProfileControlsOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type GetProfileControlsOptions

type GetProfileControlsOptions struct {
	// The profile ID. The ID can be obtained from the Security and Compliance Center UI by clicking the profile name. The
	// URL contains the ID.
	ProfileID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

	// The offset of the profiles.
	Offset *int64 `json:"-"`

	// The number of profiles that are included per page.
	Limit *int64 `json:"-"`

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

GetProfileControlsOptions : The GetProfileControls options.

func (*GetProfileControlsOptions) SetAccountID

func (_options *GetProfileControlsOptions) SetAccountID(accountID string) *GetProfileControlsOptions

SetAccountID : Allow user to set AccountID

func (*GetProfileControlsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetProfileControlsOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*GetProfileControlsOptions) SetOffset

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

SetOffset : Allow user to set Offset

func (*GetProfileControlsOptions) SetProfileID

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

SetProfileID : Allow user to set ProfileID

func (*GetProfileControlsOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type GetProfileOptions

type GetProfileOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

	// The profile type name. The name can be authored/custom/predefined for profiles and profile_group for group profiles.
	ProfileType *string `json:"-" validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

GetProfileOptions : The GetProfile options.

func (*GetProfileOptions) SetAccountID

func (_options *GetProfileOptions) SetAccountID(accountID string) *GetProfileOptions

SetAccountID : Allow user to set AccountID

func (*GetProfileOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetProfileOptions) SetID

func (_options *GetProfileOptions) SetID(id string) *GetProfileOptions

SetID : Allow user to set ID

func (*GetProfileOptions) SetProfileType

func (_options *GetProfileOptions) SetProfileType(profileType string) *GetProfileOptions

SetProfileType : Allow user to set ProfileType

func (*GetProfileOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type GetScopeDetailsCollectorOptions

type GetScopeDetailsCollectorOptions struct {
	// The unique identifier that is used to trace an entire Scope request.
	ScopeID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

GetScopeDetailsCollectorOptions : The GetScopeDetailsCollector options.

func (*GetScopeDetailsCollectorOptions) SetAccountID

func (_options *GetScopeDetailsCollectorOptions) SetAccountID(accountID string) *GetScopeDetailsCollectorOptions

SetAccountID : Allow user to set AccountID

func (*GetScopeDetailsCollectorOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*GetScopeDetailsCollectorOptions) SetScopeID

SetScopeID : Allow user to set ScopeID

func (*GetScopeDetailsCollectorOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type GetScopeDetailsCredentialsOptions

type GetScopeDetailsCredentialsOptions struct {
	// The unique identifier that is used to trace an entire Scope request.
	ScopeID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

GetScopeDetailsCredentialsOptions : The GetScopeDetailsCredentials options.

func (*GetScopeDetailsCredentialsOptions) SetAccountID

SetAccountID : Allow user to set AccountID

func (*GetScopeDetailsCredentialsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*GetScopeDetailsCredentialsOptions) SetScopeID

SetScopeID : Allow user to set ScopeID

func (*GetScopeDetailsCredentialsOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type GetScopeDetailsOptions

type GetScopeDetailsOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

GetScopeDetailsOptions : The GetScopeDetails options.

func (*GetScopeDetailsOptions) SetAccountID

func (_options *GetScopeDetailsOptions) SetAccountID(accountID string) *GetScopeDetailsOptions

SetAccountID : Allow user to set AccountID

func (*GetScopeDetailsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetScopeDetailsOptions) SetID

SetID : Allow user to set ID

func (*GetScopeDetailsOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type GetScopeTimelineOptions

type GetScopeTimelineOptions struct {
	// The unique identifier that is used to trace an entire Scope request.
	ScopeID *string `json:"-" validate:"required,ne="`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

GetScopeTimelineOptions : The GetScopeTimeline options.

func (*GetScopeTimelineOptions) SetAccountID

func (_options *GetScopeTimelineOptions) SetAccountID(accountID string) *GetScopeTimelineOptions

SetAccountID : Allow user to set AccountID

func (*GetScopeTimelineOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetScopeTimelineOptions) SetScopeID

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

SetScopeID : Allow user to set ScopeID

func (*GetScopeTimelineOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type Goal

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

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

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

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

	// The report's time of completion.
	CompletedTime *strfmt.DateTime `json:"completed_time,omitempty"`

	// The error that occurred 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.
	ApplicabilityCriteria *GoalApplicabilityCriteria `json:"applicability_criteria,omitempty"`
}

Goal : The goals that are on the 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 can be applied to.
	EnvironmentCategory []string `json:"environment_category,omitempty"`

	// The type of resource that a profile can 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"`

	// 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 GoalItem

type GoalItem struct {
	// The description of the goal.
	Description *string `json:"description" validate:"required"`

	// The goal ID.
	ID *string `json:"id" validate:"required"`

	// The severity of the goal.
	Severity *string `json:"severity" validate:"required"`

	// The goal is manually checked.
	IsManual *bool `json:"is_manual" validate:"required"`

	// The goal is remediable or not.
	IsRemediable *bool `json:"is_remediable" validate:"required"`

	// The goal is reversible or not.
	IsReversible *bool `json:"is_reversible" validate:"required"`

	// The goal is automatable or not.
	IsAutomatable *bool `json:"is_automatable" validate:"required"`

	// The goal is autoremediable or not.
	IsAutoRemediable *bool `json:"is_auto_remediable" validate:"required"`
}

GoalItem : The details of the goal.

type ImportProfilesOptions

type ImportProfilesOptions struct {
	// The import data file that you want to use to import a profile.
	File io.ReadCloser `json:"-" validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

ImportProfilesOptions : The ImportProfiles options.

func (*ImportProfilesOptions) SetAccountID

func (_options *ImportProfilesOptions) SetAccountID(accountID string) *ImportProfilesOptions

SetAccountID : Allow user to set AccountID

func (*ImportProfilesOptions) SetFile

func (_options *ImportProfilesOptions) SetFile(file io.ReadCloser) *ImportProfilesOptions

SetFile : Allow user to set File

func (*ImportProfilesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ImportProfilesOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type ListCollectorsOptions

type ListCollectorsOptions struct {
	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

ListCollectorsOptions : The ListCollectors options.

func (*ListCollectorsOptions) SetAccountID

func (_options *ListCollectorsOptions) SetAccountID(accountID string) *ListCollectorsOptions

SetAccountID : Allow user to set AccountID

func (*ListCollectorsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListCollectorsOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type ListCredentialsOptions

type ListCredentialsOptions struct {
	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// The offset of the profiles.
	Offset *int64 `json:"-"`

	// The number of profiles that are included per page.
	Limit *int64 `json:"-"`

	// 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 `json:"-"`

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

ListCredentialsOptions : The ListCredentials options.

func (*ListCredentialsOptions) SetAccountID

func (_options *ListCredentialsOptions) SetAccountID(accountID string) *ListCredentialsOptions

SetAccountID : Allow user to set AccountID

func (*ListCredentialsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListCredentialsOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListCredentialsOptions) SetOffset

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

SetOffset : Allow user to set Offset

func (*ListCredentialsOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type ListLatestScansOptions

type ListLatestScansOptions struct {
	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

	// The offset of the profiles.
	Offset *int64 `json:"-"`

	// The number of profiles that are included per page.
	Limit *int64 `json:"-"`

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

ListLatestScansOptions : The ListLatestScans options.

func (*ListLatestScansOptions) SetAccountID

func (_options *ListLatestScansOptions) SetAccountID(accountID string) *ListLatestScansOptions

SetAccountID : Allow user to set AccountID

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 {
	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

	// The offset of the profiles.
	Offset *int64 `json:"-"`

	// The number of profiles that are included per page.
	Limit *int64 `json:"-"`

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

ListProfilesOptions : The ListProfiles options.

func (*ListProfilesOptions) SetAccountID

func (_options *ListProfilesOptions) SetAccountID(accountID string) *ListProfilesOptions

SetAccountID : Allow user to set AccountID

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 {
	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

ListScopesOptions : The ListScopes options.

func (*ListScopesOptions) SetAccountID

func (_options *ListScopesOptions) SetAccountID(accountID string) *ListScopesOptions

SetAccountID : Allow user to set AccountID

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 NewCredentialDisplayFields

type NewCredentialDisplayFields struct {
	// The IBM Cloud API Key. The API key is mandatory when IBM is selected as the credential type.
	IBMAPIKey *string `json:"ibm_api_key,omitempty"`

	// The Amazon Web Services client ID. The client ID is mandatory when AWS Cloud is selected as the credential type.
	AwsClientID *string `json:"aws_client_id,omitempty"`

	// The Amazon Web Services client secret. The client secret is mandatory when AWS Cloud is selected as the credential
	// type.
	AwsClientSecret *string `json:"aws_client_secret,omitempty"`

	// The Amazon Web Services region. The region is used when AWS Cloud is selected as the credential type.
	AwsRegion *string `json:"aws_region,omitempty"`

	// The Amazon Web Services arn value. The arn value is used when AWS Cloud is selected as the credential type.
	AwsArn *string `json:"aws_arn,omitempty"`

	// The username of the user. The username is mandatory when the credential type is DataBase, Kerberos, OpenStack, and
	// Username-Password.
	Username *string `json:"username,omitempty"`

	// The password of the user. The password is mandatory when the credential type is DataBase, Kerberos, OpenStack, and
	// Username-Password.
	Password *string `json:"password,omitempty"`

	// The Microsoft Azure client ID. The client ID is mandatory when Azure is selected as the credential type.
	AzureClientID *string `json:"azure_client_id,omitempty"`

	// The Microsoft Azure client secret. The secret is mandatory when the type of credential is set to Azure.
	AzureClientSecret *string `json:"azure_client_secret,omitempty"`

	// The Microsoft Azure subscription ID. The subscription ID is mandatory when the type of credential is set to Azure.
	AzureSubscriptionID *string `json:"azure_subscription_id,omitempty"`

	// The Microsoft Azure resource group. The resource group is used when Azure is the credential type.
	AzureResourceGroup *string `json:"azure_resource_group,omitempty"`

	// The database name. The database name is mandatory when Database is the credential type.
	DatabaseName *string `json:"database_name,omitempty"`

	// The Kerberos Windows authentication type. The authentication type is mandatory when the credential type is Kerberos
	// Windows.
	WinrmAuthtype *string `json:"winrm_authtype,omitempty"`

	// The Kerberos Windows SSL. The SSL is mandatory when the credential type is Kerberos Windows.
	WinrmUsessl *string `json:"winrm_usessl,omitempty"`

	// The Kerberos Windows port. The port is mandatory When Kerberos Windows is the credential type.
	WinrmPort *string `json:"winrm_port,omitempty"`

	// The Microsoft 365 client ID. The client ID is mandatory when Microsoft 365 is the credential type.
	Ms365ClientID *string `json:"ms_365_client_id,omitempty"`

	// The Microsoft 365 client secret. The secret is mandatory when Microsoft 365 is the credential type.
	Ms365ClientSecret *string `json:"ms_365_client_secret,omitempty"`

	// The Microsoft 365 tenant ID. The tenant ID is mandatory when Microsoft 365 is the credential type.
	Ms365TenantID *string `json:"ms_365_tenant_id,omitempty"`

	// The auth url of the OpenStack cloud. The auth url is mandatory when OpenStack is the credential type.
	AuthURL *string `json:"auth_url,omitempty"`

	// The project name of the OpenStack cloud. The project name is mandatory when OpenStack is the credential type.
	ProjectName *string `json:"project_name,omitempty"`

	// The user domain name of the OpenStack cloud. The domain name is mandatory when OpenStack is the credential type.
	UserDomainName *string `json:"user_domain_name,omitempty"`

	// The project domain name of the OpenStack cloud. The project domain name is mandatory when OpenStack is the
	// credential type.
	ProjectDomainName *string `json:"project_domain_name,omitempty"`

	// The user pem file name.
	PemFileName *string `json:"pem_file_name,omitempty"`

	// The base64 encoded form of pem.
	PemData *string `json:"pem_data,omitempty"`
}

NewCredentialDisplayFields : The details of the credential. The details change as the selected credential type varies.

type PageLink struct {
	// The URL of a page.
	Href *string `json:"href" validate:"required"`
}

PageLink : The URL of a page.

type PostureManagementV2

type PostureManagementV2 struct {
	Service *core.BaseService
}

PostureManagementV2 : 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.

API Version: 2.0.0

func NewPostureManagementV2

func NewPostureManagementV2(options *PostureManagementV2Options) (service *PostureManagementV2, err error)

NewPostureManagementV2 : constructs an instance of PostureManagementV2 with passed in options.

func NewPostureManagementV2UsingExternalConfig

func NewPostureManagementV2UsingExternalConfig(options *PostureManagementV2Options) (postureManagement *PostureManagementV2, err error)

NewPostureManagementV2UsingExternalConfig : constructs an instance of PostureManagementV2 with passed in options and external configuration.

func (*PostureManagementV2) Clone

func (postureManagement *PostureManagementV2) Clone() *PostureManagementV2

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

func (*PostureManagementV2) CreateCollector

func (postureManagement *PostureManagementV2) 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 (*PostureManagementV2) CreateCollectorWithContext

func (postureManagement *PostureManagementV2) 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 (*PostureManagementV2) CreateCredential

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

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

func (*PostureManagementV2) CreateCredentialWithContext

func (postureManagement *PostureManagementV2) 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 (*PostureManagementV2) CreateScope

func (postureManagement *PostureManagementV2) 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 (*PostureManagementV2) CreateScopeWithContext

func (postureManagement *PostureManagementV2) 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 (*PostureManagementV2) CreateValidation

func (postureManagement *PostureManagementV2) 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 configure a collector, provided credentials, and completed both a fact collection and discovery scan. [Learn more](/docs/security-compliance?topic=security-compliance-schedule-scan).

func (*PostureManagementV2) CreateValidationWithContext

func (postureManagement *PostureManagementV2) 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 (*PostureManagementV2) DeleteCollector

func (postureManagement *PostureManagementV2) DeleteCollector(deleteCollectorOptions *DeleteCollectorOptions) (response *core.DetailedResponse, err error)

DeleteCollector : Delete a collector Delete a collector from the Security and Compliance Center that you no longer need.

func (*PostureManagementV2) DeleteCollectorWithContext

func (postureManagement *PostureManagementV2) DeleteCollectorWithContext(ctx context.Context, deleteCollectorOptions *DeleteCollectorOptions) (response *core.DetailedResponse, err error)

DeleteCollectorWithContext is an alternate form of the DeleteCollector method which supports a Context parameter

func (*PostureManagementV2) DeleteCredential

func (postureManagement *PostureManagementV2) DeleteCredential(deleteCredentialOptions *DeleteCredentialOptions) (response *core.DetailedResponse, err error)

DeleteCredential : Delete a credential If you no longer need to use a credential, you can remove it from the Security and Compliance Center.

func (*PostureManagementV2) DeleteCredentialWithContext

func (postureManagement *PostureManagementV2) DeleteCredentialWithContext(ctx context.Context, deleteCredentialOptions *DeleteCredentialOptions) (response *core.DetailedResponse, err error)

DeleteCredentialWithContext is an alternate form of the DeleteCredential method which supports a Context parameter

func (*PostureManagementV2) DeleteProfile

func (postureManagement *PostureManagementV2) DeleteProfile(deleteProfileOptions *DeleteProfileOptions) (response *core.DetailedResponse, err error)

DeleteProfile : Delete a profile Delete a custom profile that was previously created in your account.

func (*PostureManagementV2) DeleteProfileWithContext

func (postureManagement *PostureManagementV2) DeleteProfileWithContext(ctx context.Context, deleteProfileOptions *DeleteProfileOptions) (response *core.DetailedResponse, err error)

DeleteProfileWithContext is an alternate form of the DeleteProfile method which supports a Context parameter

func (*PostureManagementV2) DeleteScope

func (postureManagement *PostureManagementV2) DeleteScope(deleteScopeOptions *DeleteScopeOptions) (response *core.DetailedResponse, err error)

DeleteScope : Delete a scope If you no longer need to target a specific scope with your scan, you can delete it.

func (*PostureManagementV2) DeleteScopeWithContext

func (postureManagement *PostureManagementV2) DeleteScopeWithContext(ctx context.Context, deleteScopeOptions *DeleteScopeOptions) (response *core.DetailedResponse, err error)

DeleteScopeWithContext is an alternate form of the DeleteScope method which supports a Context parameter

func (*PostureManagementV2) DisableRetries

func (postureManagement *PostureManagementV2) DisableRetries()

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

func (*PostureManagementV2) EnableRetries

func (postureManagement *PostureManagementV2) 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 (*PostureManagementV2) GetCollector

func (postureManagement *PostureManagementV2) GetCollector(getCollectorOptions *GetCollectorOptions) (result *Collector, response *core.DetailedResponse, err error)

GetCollector : View collector details View collector details .

func (*PostureManagementV2) GetCollectorWithContext

func (postureManagement *PostureManagementV2) GetCollectorWithContext(ctx context.Context, getCollectorOptions *GetCollectorOptions) (result *Collector, response *core.DetailedResponse, err error)

GetCollectorWithContext is an alternate form of the GetCollector method which supports a Context parameter

func (*PostureManagementV2) GetCorrelationID

func (postureManagement *PostureManagementV2) GetCorrelationID(getCorrelationIDOptions *GetCorrelationIDOptions) (result *ScopeTaskStatus, response *core.DetailedResponse, err error)

GetCorrelationID : Get status of a scope Get the status of any task. By providing a correlation ID, you can track the status of any task that is running or completed. So, for example, you can check the status of an initial discovery after scope creation or the status of validation after a scan is triggered.

func (*PostureManagementV2) GetCorrelationIDWithContext

func (postureManagement *PostureManagementV2) GetCorrelationIDWithContext(ctx context.Context, getCorrelationIDOptions *GetCorrelationIDOptions) (result *ScopeTaskStatus, response *core.DetailedResponse, err error)

GetCorrelationIDWithContext is an alternate form of the GetCorrelationID method which supports a Context parameter

func (*PostureManagementV2) GetCredential

func (postureManagement *PostureManagementV2) GetCredential(getCredentialOptions *GetCredentialOptions) (result *Credential, response *core.DetailedResponse, err error)

GetCredential : View credential details View the details of a stored credential, which include its name, type, and secret.

func (*PostureManagementV2) GetCredentialWithContext

func (postureManagement *PostureManagementV2) GetCredentialWithContext(ctx context.Context, getCredentialOptions *GetCredentialOptions) (result *Credential, response *core.DetailedResponse, err error)

GetCredentialWithContext is an alternate form of the GetCredential method which supports a Context parameter

func (*PostureManagementV2) GetEnableGzipCompression

func (postureManagement *PostureManagementV2) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*PostureManagementV2) GetGroupProfileControls

func (postureManagement *PostureManagementV2) GetGroupProfileControls(getGroupProfileControlsOptions *GetGroupProfileControlsOptions) (result *ControlList, response *core.DetailedResponse, err error)

GetGroupProfileControls : View group profile controls View the controls and goals that are available as part of a profile group.

func (*PostureManagementV2) GetGroupProfileControlsWithContext

func (postureManagement *PostureManagementV2) GetGroupProfileControlsWithContext(ctx context.Context, getGroupProfileControlsOptions *GetGroupProfileControlsOptions) (result *ControlList, response *core.DetailedResponse, err error)

GetGroupProfileControlsWithContext is an alternate form of the GetGroupProfileControls method which supports a Context parameter

func (*PostureManagementV2) GetProfile

func (postureManagement *PostureManagementV2) GetProfile(getProfileOptions *GetProfileOptions) (result *Profile, response *core.DetailedResponse, err error)

GetProfile : View profile details View profile details.

func (*PostureManagementV2) GetProfileControls

func (postureManagement *PostureManagementV2) GetProfileControls(getProfileControlsOptions *GetProfileControlsOptions) (result *ControlList, response *core.DetailedResponse, err error)

GetProfileControls : View profile controls View a list of the controls and their associated goals for a specified profile.

func (*PostureManagementV2) GetProfileControlsWithContext

func (postureManagement *PostureManagementV2) GetProfileControlsWithContext(ctx context.Context, getProfileControlsOptions *GetProfileControlsOptions) (result *ControlList, response *core.DetailedResponse, err error)

GetProfileControlsWithContext is an alternate form of the GetProfileControls method which supports a Context parameter

func (*PostureManagementV2) GetProfileWithContext

func (postureManagement *PostureManagementV2) GetProfileWithContext(ctx context.Context, getProfileOptions *GetProfileOptions) (result *Profile, response *core.DetailedResponse, err error)

GetProfileWithContext is an alternate form of the GetProfile method which supports a Context parameter

func (*PostureManagementV2) GetScopeDetails

func (postureManagement *PostureManagementV2) GetScopeDetails(getScopeDetailsOptions *GetScopeDetailsOptions) (result *Scope, response *core.DetailedResponse, err error)

GetScopeDetails : View scope details View the details of a specific scope.

func (*PostureManagementV2) GetScopeDetailsCollector

func (postureManagement *PostureManagementV2) GetScopeDetailsCollector(getScopeDetailsCollectorOptions *GetScopeDetailsCollectorOptions) (result *ScopeCollector, response *core.DetailedResponse, err error)

GetScopeDetailsCollector : Get a scope's collector Get the collector that is associated with a scope.

func (*PostureManagementV2) GetScopeDetailsCollectorWithContext

func (postureManagement *PostureManagementV2) GetScopeDetailsCollectorWithContext(ctx context.Context, getScopeDetailsCollectorOptions *GetScopeDetailsCollectorOptions) (result *ScopeCollector, response *core.DetailedResponse, err error)

GetScopeDetailsCollectorWithContext is an alternate form of the GetScopeDetailsCollector method which supports a Context parameter

func (*PostureManagementV2) GetScopeDetailsCredentials

func (postureManagement *PostureManagementV2) GetScopeDetailsCredentials(getScopeDetailsCredentialsOptions *GetScopeDetailsCredentialsOptions) (result *ScopeCredential, response *core.DetailedResponse, err error)

GetScopeDetailsCredentials : Get a scope's credentials Get the credentials that are associated with a scope.

func (*PostureManagementV2) GetScopeDetailsCredentialsWithContext

func (postureManagement *PostureManagementV2) GetScopeDetailsCredentialsWithContext(ctx context.Context, getScopeDetailsCredentialsOptions *GetScopeDetailsCredentialsOptions) (result *ScopeCredential, response *core.DetailedResponse, err error)

GetScopeDetailsCredentialsWithContext is an alternate form of the GetScopeDetailsCredentials method which supports a Context parameter

func (*PostureManagementV2) GetScopeDetailsWithContext

func (postureManagement *PostureManagementV2) GetScopeDetailsWithContext(ctx context.Context, getScopeDetailsOptions *GetScopeDetailsOptions) (result *Scope, response *core.DetailedResponse, err error)

GetScopeDetailsWithContext is an alternate form of the GetScopeDetails method which supports a Context parameter

func (*PostureManagementV2) GetScopeTimeline

func (postureManagement *PostureManagementV2) GetScopeTimeline(getScopeTimelineOptions *GetScopeTimelineOptions) (result *EventList, response *core.DetailedResponse, err error)

GetScopeTimeline : Get scope event history Get the list of events for a scope such as the last discovery or fact collection.

func (*PostureManagementV2) GetScopeTimelineWithContext

func (postureManagement *PostureManagementV2) GetScopeTimelineWithContext(ctx context.Context, getScopeTimelineOptions *GetScopeTimelineOptions) (result *EventList, response *core.DetailedResponse, err error)

GetScopeTimelineWithContext is an alternate form of the GetScopeTimeline method which supports a Context parameter

func (*PostureManagementV2) GetServiceURL

func (postureManagement *PostureManagementV2) GetServiceURL() string

GetServiceURL returns the service URL

func (*PostureManagementV2) ImportProfiles

func (postureManagement *PostureManagementV2) ImportProfiles(importProfilesOptions *ImportProfilesOptions) (result *BasicResult, response *core.DetailedResponse, err error)

ImportProfiles : Import profile Import a profile that you formatted locally. For more information about how your profile must be formatted, see [the docs](/docs/security-compliance?topic=security-compliance-custom-profiles#CSV-format).

func (*PostureManagementV2) ImportProfilesWithContext

func (postureManagement *PostureManagementV2) ImportProfilesWithContext(ctx context.Context, importProfilesOptions *ImportProfilesOptions) (result *BasicResult, response *core.DetailedResponse, err error)

ImportProfilesWithContext is an alternate form of the ImportProfiles method which supports a Context parameter

func (*PostureManagementV2) ListCollectors

func (postureManagement *PostureManagementV2) ListCollectors(listCollectorsOptions *ListCollectorsOptions) (result *CollectorList, response *core.DetailedResponse, err error)

ListCollectors : List collectors View a list of all of the collectors that are available in your account and their status.

func (*PostureManagementV2) ListCollectorsWithContext

func (postureManagement *PostureManagementV2) ListCollectorsWithContext(ctx context.Context, listCollectorsOptions *ListCollectorsOptions) (result *CollectorList, response *core.DetailedResponse, err error)

ListCollectorsWithContext is an alternate form of the ListCollectors method which supports a Context parameter

func (*PostureManagementV2) ListCredentials

func (postureManagement *PostureManagementV2) ListCredentials(listCredentialsOptions *ListCredentialsOptions) (result *CredentialList, response *core.DetailedResponse, err error)

ListCredentials : List credentials List the credentials that were previously added to the Security and Compliance Center.

func (*PostureManagementV2) ListCredentialsWithContext

func (postureManagement *PostureManagementV2) ListCredentialsWithContext(ctx context.Context, listCredentialsOptions *ListCredentialsOptions) (result *CredentialList, response *core.DetailedResponse, err error)

ListCredentialsWithContext is an alternate form of the ListCredentials method which supports a Context parameter

func (*PostureManagementV2) ListLatestScans

func (postureManagement *PostureManagementV2) ListLatestScans(listLatestScansOptions *ListLatestScansOptions) (result *ScanList, 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 (*PostureManagementV2) ListLatestScansWithContext

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

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

func (*PostureManagementV2) ListProfiles

func (postureManagement *PostureManagementV2) ListProfiles(listProfilesOptions *ListProfilesOptions) (result *ProfileList, 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 (*PostureManagementV2) ListProfilesWithContext

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

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

func (*PostureManagementV2) ListScopes

func (postureManagement *PostureManagementV2) ListScopes(listScopesOptions *ListScopesOptions) (result *ScopeList, 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 (*PostureManagementV2) ListScopesWithContext

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

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

func (*PostureManagementV2) NewCreateCollectorOptions

func (*PostureManagementV2) NewCreateCollectorOptions(name string, isPublic bool, managedBy string) *CreateCollectorOptions

NewCreateCollectorOptions : Instantiate CreateCollectorOptions

func (*PostureManagementV2) NewCreateCredentialOptions

func (*PostureManagementV2) NewCreateCredentialOptions(enabled bool, typeVar string, name string, description string, displayFields *NewCredentialDisplayFields, purpose string) *CreateCredentialOptions

NewCreateCredentialOptions : Instantiate CreateCredentialOptions

func (*PostureManagementV2) NewCreateScopeOptions

func (*PostureManagementV2) NewCreateScopeOptions(name string, description string, collectorIds []string, credentialID string, credentialType string) *CreateScopeOptions

NewCreateScopeOptions : Instantiate CreateScopeOptions

func (*PostureManagementV2) NewCreateValidationOptions

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

NewCreateValidationOptions : Instantiate CreateValidationOptions

func (*PostureManagementV2) NewDeleteCollectorOptions

func (*PostureManagementV2) NewDeleteCollectorOptions(id string) *DeleteCollectorOptions

NewDeleteCollectorOptions : Instantiate DeleteCollectorOptions

func (*PostureManagementV2) NewDeleteCredentialOptions

func (*PostureManagementV2) NewDeleteCredentialOptions(id string) *DeleteCredentialOptions

NewDeleteCredentialOptions : Instantiate DeleteCredentialOptions

func (*PostureManagementV2) NewDeleteProfileOptions

func (*PostureManagementV2) NewDeleteProfileOptions(id string) *DeleteProfileOptions

NewDeleteProfileOptions : Instantiate DeleteProfileOptions

func (*PostureManagementV2) NewDeleteScopeOptions

func (*PostureManagementV2) NewDeleteScopeOptions(id string) *DeleteScopeOptions

NewDeleteScopeOptions : Instantiate DeleteScopeOptions

func (*PostureManagementV2) NewGetCollectorOptions

func (*PostureManagementV2) NewGetCollectorOptions(id string) *GetCollectorOptions

NewGetCollectorOptions : Instantiate GetCollectorOptions

func (*PostureManagementV2) NewGetCorrelationIDOptions

func (*PostureManagementV2) NewGetCorrelationIDOptions(correlationID string) *GetCorrelationIDOptions

NewGetCorrelationIDOptions : Instantiate GetCorrelationIDOptions

func (*PostureManagementV2) NewGetCredentialOptions

func (*PostureManagementV2) NewGetCredentialOptions(id string) *GetCredentialOptions

NewGetCredentialOptions : Instantiate GetCredentialOptions

func (*PostureManagementV2) NewGetGroupProfileControlsOptions

func (*PostureManagementV2) NewGetGroupProfileControlsOptions(groupID string) *GetGroupProfileControlsOptions

NewGetGroupProfileControlsOptions : Instantiate GetGroupProfileControlsOptions

func (*PostureManagementV2) NewGetProfileControlsOptions

func (*PostureManagementV2) NewGetProfileControlsOptions(profileID string) *GetProfileControlsOptions

NewGetProfileControlsOptions : Instantiate GetProfileControlsOptions

func (*PostureManagementV2) NewGetProfileOptions

func (*PostureManagementV2) NewGetProfileOptions(id string, profileType string) *GetProfileOptions

NewGetProfileOptions : Instantiate GetProfileOptions

func (*PostureManagementV2) NewGetScopeDetailsCollectorOptions

func (*PostureManagementV2) NewGetScopeDetailsCollectorOptions(scopeID string) *GetScopeDetailsCollectorOptions

NewGetScopeDetailsCollectorOptions : Instantiate GetScopeDetailsCollectorOptions

func (*PostureManagementV2) NewGetScopeDetailsCredentialsOptions

func (*PostureManagementV2) NewGetScopeDetailsCredentialsOptions(scopeID string) *GetScopeDetailsCredentialsOptions

NewGetScopeDetailsCredentialsOptions : Instantiate GetScopeDetailsCredentialsOptions

func (*PostureManagementV2) NewGetScopeDetailsOptions

func (*PostureManagementV2) NewGetScopeDetailsOptions(id string) *GetScopeDetailsOptions

NewGetScopeDetailsOptions : Instantiate GetScopeDetailsOptions

func (*PostureManagementV2) NewGetScopeTimelineOptions

func (*PostureManagementV2) NewGetScopeTimelineOptions(scopeID string) *GetScopeTimelineOptions

NewGetScopeTimelineOptions : Instantiate GetScopeTimelineOptions

func (*PostureManagementV2) NewImportProfilesOptions

func (*PostureManagementV2) NewImportProfilesOptions(file io.ReadCloser) *ImportProfilesOptions

NewImportProfilesOptions : Instantiate ImportProfilesOptions

func (*PostureManagementV2) NewListCollectorsOptions

func (*PostureManagementV2) NewListCollectorsOptions() *ListCollectorsOptions

NewListCollectorsOptions : Instantiate ListCollectorsOptions

func (*PostureManagementV2) NewListCredentialsOptions

func (*PostureManagementV2) NewListCredentialsOptions() *ListCredentialsOptions

NewListCredentialsOptions : Instantiate ListCredentialsOptions

func (*PostureManagementV2) NewListLatestScansOptions

func (*PostureManagementV2) NewListLatestScansOptions() *ListLatestScansOptions

NewListLatestScansOptions : Instantiate ListLatestScansOptions

func (*PostureManagementV2) NewListProfilesOptions

func (*PostureManagementV2) NewListProfilesOptions() *ListProfilesOptions

NewListProfilesOptions : Instantiate ListProfilesOptions

func (*PostureManagementV2) NewListScopesOptions

func (*PostureManagementV2) NewListScopesOptions() *ListScopesOptions

NewListScopesOptions : Instantiate ListScopesOptions

func (*PostureManagementV2) NewReplaceScopeDetailsCollectorOptions

func (*PostureManagementV2) NewReplaceScopeDetailsCollectorOptions(scopeID string, collectorIds []string) *ReplaceScopeDetailsCollectorOptions

NewReplaceScopeDetailsCollectorOptions : Instantiate ReplaceScopeDetailsCollectorOptions

func (*PostureManagementV2) NewReplaceScopeDetailsCredentialsOptions

func (*PostureManagementV2) NewReplaceScopeDetailsCredentialsOptions(scopeID string, credentialID string) *ReplaceScopeDetailsCredentialsOptions

NewReplaceScopeDetailsCredentialsOptions : Instantiate ReplaceScopeDetailsCredentialsOptions

func (*PostureManagementV2) NewScanSummariesOptions

func (*PostureManagementV2) NewScanSummariesOptions(reportSettingID string) *ScanSummariesOptions

NewScanSummariesOptions : Instantiate ScanSummariesOptions

func (*PostureManagementV2) NewScansSummaryOptions

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

NewScansSummaryOptions : Instantiate ScansSummaryOptions

func (*PostureManagementV2) NewScopeCollector

func (*PostureManagementV2) NewScopeCollector(collectorIds []string) (_model *ScopeCollector, err error)

NewScopeCollector : Instantiate ScopeCollector (Generic Model Constructor)

func (*PostureManagementV2) NewScopeCredential

func (*PostureManagementV2) NewScopeCredential(credentialID string) (_model *ScopeCredential, err error)

NewScopeCredential : Instantiate ScopeCredential (Generic Model Constructor)

func (*PostureManagementV2) NewUpdateCollectorOptions

func (*PostureManagementV2) NewUpdateCollectorOptions(id string, collector map[string]interface{}) *UpdateCollectorOptions

NewUpdateCollectorOptions : Instantiate UpdateCollectorOptions

func (*PostureManagementV2) NewUpdateCredentialOptions

func (*PostureManagementV2) NewUpdateCredentialOptions(id string) *UpdateCredentialOptions

NewUpdateCredentialOptions : Instantiate UpdateCredentialOptions

func (*PostureManagementV2) NewUpdateProfilesOptions

func (*PostureManagementV2) NewUpdateProfilesOptions(id string) *UpdateProfilesOptions

NewUpdateProfilesOptions : Instantiate UpdateProfilesOptions

func (*PostureManagementV2) NewUpdateScopeDetailsOptions

func (*PostureManagementV2) NewUpdateScopeDetailsOptions(id string) *UpdateScopeDetailsOptions

NewUpdateScopeDetailsOptions : Instantiate UpdateScopeDetailsOptions

func (*PostureManagementV2) ReplaceScopeDetailsCollector

func (postureManagement *PostureManagementV2) ReplaceScopeDetailsCollector(replaceScopeDetailsCollectorOptions *ReplaceScopeDetailsCollectorOptions) (result *ScopeCollector, response *core.DetailedResponse, err error)

ReplaceScopeDetailsCollector : Update a scope's collector Update the collector that is associated with a scope.

func (*PostureManagementV2) ReplaceScopeDetailsCollectorWithContext

func (postureManagement *PostureManagementV2) ReplaceScopeDetailsCollectorWithContext(ctx context.Context, replaceScopeDetailsCollectorOptions *ReplaceScopeDetailsCollectorOptions) (result *ScopeCollector, response *core.DetailedResponse, err error)

ReplaceScopeDetailsCollectorWithContext is an alternate form of the ReplaceScopeDetailsCollector method which supports a Context parameter

func (*PostureManagementV2) ReplaceScopeDetailsCredentials

func (postureManagement *PostureManagementV2) ReplaceScopeDetailsCredentials(replaceScopeDetailsCredentialsOptions *ReplaceScopeDetailsCredentialsOptions) (result *ScopeCredential, response *core.DetailedResponse, err error)

ReplaceScopeDetailsCredentials : Update a scope's credentials Update the credentials that are associated with a scope.

func (*PostureManagementV2) ReplaceScopeDetailsCredentialsWithContext

func (postureManagement *PostureManagementV2) ReplaceScopeDetailsCredentialsWithContext(ctx context.Context, replaceScopeDetailsCredentialsOptions *ReplaceScopeDetailsCredentialsOptions) (result *ScopeCredential, response *core.DetailedResponse, err error)

ReplaceScopeDetailsCredentialsWithContext is an alternate form of the ReplaceScopeDetailsCredentials method which supports a Context parameter

func (*PostureManagementV2) ScanSummaries

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

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

func (*PostureManagementV2) ScanSummariesWithContext

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

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

func (*PostureManagementV2) ScansSummary

func (postureManagement *PostureManagementV2) 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/v2/scans/validations/latest_scans" endpoint.

func (*PostureManagementV2) ScansSummaryWithContext

func (postureManagement *PostureManagementV2) 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 (*PostureManagementV2) SetDefaultHeaders

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

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*PostureManagementV2) SetEnableGzipCompression

func (postureManagement *PostureManagementV2) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*PostureManagementV2) SetServiceURL

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

SetServiceURL sets the service URL

func (*PostureManagementV2) UpdateCollector

func (postureManagement *PostureManagementV2) UpdateCollector(updateCollectorOptions *UpdateCollectorOptions) (result *Collector, response *core.DetailedResponse, err error)

UpdateCollector : Update a collector Update a collector.

func (*PostureManagementV2) UpdateCollectorWithContext

func (postureManagement *PostureManagementV2) UpdateCollectorWithContext(ctx context.Context, updateCollectorOptions *UpdateCollectorOptions) (result *Collector, response *core.DetailedResponse, err error)

UpdateCollectorWithContext is an alternate form of the UpdateCollector method which supports a Context parameter

func (*PostureManagementV2) UpdateCredential

func (postureManagement *PostureManagementV2) UpdateCredential(updateCredentialOptions *UpdateCredentialOptions) (result *Credential, response *core.DetailedResponse, err error)

UpdateCredential : Update a credential Update the way that a credential is stored in the Security and Compliance Center, or update the credential itself.

func (*PostureManagementV2) UpdateCredentialWithContext

func (postureManagement *PostureManagementV2) UpdateCredentialWithContext(ctx context.Context, updateCredentialOptions *UpdateCredentialOptions) (result *Credential, response *core.DetailedResponse, err error)

UpdateCredentialWithContext is an alternate form of the UpdateCredential method which supports a Context parameter

func (*PostureManagementV2) UpdateProfiles

func (postureManagement *PostureManagementV2) UpdateProfiles(updateProfilesOptions *UpdateProfilesOptions) (result *Profile, response *core.DetailedResponse, err error)

UpdateProfiles : Update a profile Update a profile. Set the enable field to false to mark the profile as deleted.

func (*PostureManagementV2) UpdateProfilesWithContext

func (postureManagement *PostureManagementV2) UpdateProfilesWithContext(ctx context.Context, updateProfilesOptions *UpdateProfilesOptions) (result *Profile, response *core.DetailedResponse, err error)

UpdateProfilesWithContext is an alternate form of the UpdateProfiles method which supports a Context parameter

func (*PostureManagementV2) UpdateScopeDetails

func (postureManagement *PostureManagementV2) UpdateScopeDetails(updateScopeDetailsOptions *UpdateScopeDetailsOptions) (result *Scope, response *core.DetailedResponse, err error)

UpdateScopeDetails : Update scope Update a scope's details.

func (*PostureManagementV2) UpdateScopeDetailsWithContext

func (postureManagement *PostureManagementV2) UpdateScopeDetailsWithContext(ctx context.Context, updateScopeDetailsOptions *UpdateScopeDetailsOptions) (result *Scope, response *core.DetailedResponse, err error)

UpdateScopeDetailsWithContext is an alternate form of the UpdateScopeDetails method which supports a Context parameter

type PostureManagementV2Options

type PostureManagementV2Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

PostureManagementV2Options : Service options

type Profile

type Profile struct {
	// The name of the profile.
	Name *string `json:"name" validate:"required"`

	// A description of the profile.
	Description *string `json:"description" validate:"required"`

	// The version of the profile.
	Version *int64 `json:"version" validate:"required"`

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

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

	// A reason why you want to delete a profile.
	ReasonForDelete *string `json:"reason_for_delete" validate:"required"`

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

	// An auto-generated unique identifying number of the profile.
	ID *string `json:"id" validate:"required"`

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

	// The type of profile.
	Type *string `json:"type" validate:"required"`

	// no of Controls.
	NoOfControls *int64 `json:"no_of_controls" validate:"required"`

	// The time that the profile was created in UTC.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The time that the profile was most recently modified in UTC.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// 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" validate:"required"`
}

Profile : Profile.

type ProfileItem

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

	// An auto-generated unique identifier for the scope.
	ID *string `json:"id" validate:"required"`

	// The type of profile.
	Type *string `json:"type" validate:"required"`
}

ProfileItem : Profile details.

type ProfileList

type ProfileList 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. If no profiles are available, the value of this field is 0.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The URL of a page.
	First *PageLink `json:"first" validate:"required"`

	// The URL of a page.
	Last *PageLink `json:"last" validate:"required"`

	// The URL of a page.
	Previous *PageLink `json:"previous,omitempty"`

	// The URL of a page.
	Next *PageLink `json:"next,omitempty"`

	// Profiles.
	Profiles []Profile `json:"profiles" validate:"required"`
}

ProfileList : A list of profiles.

func (*ProfileList) GetNextOffset

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

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

type ProfileResult

type ProfileResult struct {
	// The ID of the profile.
	ID *string `json:"id" validate:"required"`

	// The name of the profile.
	Name *string `json:"name" validate:"required"`

	// 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).
	Type *string `json:"type" validate:"required"`

	// The result of a scan. The controls values are not available if no scopes are available.
	ValidationResult *ScanResult `json:"validation_result" validate:"required"`
}

ProfileResult : The result of a profile.

type ReplaceScopeDetailsCollectorOptions

type ReplaceScopeDetailsCollectorOptions struct {
	// The unique identifier that is used to trace an entire Scope request.
	ScopeID *string `json:"-" validate:"required,ne="`

	// The collector IDs of the scope.
	CollectorIds []string `json:"collector_ids" validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

ReplaceScopeDetailsCollectorOptions : The ReplaceScopeDetailsCollector options.

func (*ReplaceScopeDetailsCollectorOptions) SetAccountID

SetAccountID : Allow user to set AccountID

func (*ReplaceScopeDetailsCollectorOptions) SetCollectorIds

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

SetCollectorIds : Allow user to set CollectorIds

func (*ReplaceScopeDetailsCollectorOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ReplaceScopeDetailsCollectorOptions) SetScopeID

SetScopeID : Allow user to set ScopeID

func (*ReplaceScopeDetailsCollectorOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type ReplaceScopeDetailsCredentialsOptions

type ReplaceScopeDetailsCredentialsOptions struct {
	// The unique identifier that is used to trace an entire Scope request.
	ScopeID *string `json:"-" validate:"required,ne="`

	// The credential ID of the scope.
	CredentialID *string `json:"credential_id" validate:"required"`

	// The credential attribute of the scope.
	CredentialAttribute *string `json:"credential_attribute,omitempty"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

ReplaceScopeDetailsCredentialsOptions : The ReplaceScopeDetailsCredentials options.

func (*ReplaceScopeDetailsCredentialsOptions) SetAccountID

SetAccountID : Allow user to set AccountID

func (*ReplaceScopeDetailsCredentialsOptions) SetCredentialAttribute

func (_options *ReplaceScopeDetailsCredentialsOptions) SetCredentialAttribute(credentialAttribute string) *ReplaceScopeDetailsCredentialsOptions

SetCredentialAttribute : Allow user to set CredentialAttribute

func (*ReplaceScopeDetailsCredentialsOptions) SetCredentialID

SetCredentialID : Allow user to set CredentialID

func (*ReplaceScopeDetailsCredentialsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ReplaceScopeDetailsCredentialsOptions) SetScopeID

SetScopeID : Allow user to set ScopeID

func (*ReplaceScopeDetailsCredentialsOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type ResourceResult

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

	// The resource type.
	Types *string `json:"types,omitempty"`

	// The result status of resource control.
	Status *string `json:"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 why a goal is not applicable to a resource.
	NotApplicableReason *string `json:"not_applicable_reason,omitempty"`
}

ResourceResult : The resource results.

type ResourceStatistics

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

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

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

	// The resource count of controls that are not applicable.
	NotApplicableCount *int64 `json:"not_applicable_count,omitempty"`
}

ResourceStatistics : A scan's summary controls.

type Result

type Result struct {
	// Result.
	Result *bool `json:"result" validate:"required"`

	// A message is returned.
	Message *string `json:"message" validate:"required"`
}

Result : Result.

type ScanItem

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

	// 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" validate:"required"`

	// The scope ID of the scan.
	ScopeID *string `json:"scope_id" validate:"required"`

	// The name of the scope.
	ScopeName *string `json:"scope_name" validate:"required"`

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

	// The group ID of profile.
	GroupProfileID *string `json:"group_profile_id" validate:"required"`

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

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

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

	// The unique ID for the scan that is created.
	ReportSettingID *string `json:"report_setting_id,omitempty"`

	// The date and time when the scan completed.
	EndTime *strfmt.DateTime `json:"end_time" validate:"required"`

	// The result of a scan. The controls values are not available if no scopes are available.
	Result *ScanResult `json:"result" validate:"required"`
}

ScanItem : The details of a scan.

type ScanList

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

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

	// The total number of scans that are in the list. This value is 0 when no scans are available and the detail fields
	// are not displayed in that case.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The URL of a page.
	First *PageLink `json:"first" validate:"required"`

	// The URL of a page.
	Last *PageLink `json:"last" validate:"required"`

	// The URL of a page.
	Previous *PageLink `json:"previous,omitempty"`

	// The URL of a page.
	Next *PageLink `json:"next,omitempty"`

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

ScanList : A list of scans.

func (*ScanList) GetNextOffset

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

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

type ScanResult

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

	// The number of goals that can't 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" validate:"required"`

	// 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" validate:"required"`

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

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

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

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

	// 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" validate:"required"`

	// The number of controls that can't 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" validate:"required"`

	// The total number of controls that are included in the scan.
	ControlsTotalCount *int64 `json:"controls_total_count" validate:"required"`
}

ScanResult : The result of a scan. The controls values are not available if no scopes are available.

type ScanSummariesOptions

type ScanSummariesOptions struct {
	// The report setting ID. The ID can be obtained from the /validations/latest_scans API call.
	ReportSettingID *string `json:"-" validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

	// The offset of the profiles.
	Offset *int64 `json:"-"`

	// The number of profiles that are included per page.
	Limit *int64 `json:"-"`

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

ScanSummariesOptions : The ScanSummaries options.

func (*ScanSummariesOptions) SetAccountID

func (_options *ScanSummariesOptions) SetAccountID(accountID string) *ScanSummariesOptions

SetAccountID : Allow user to set AccountID

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) SetReportSettingID

func (_options *ScanSummariesOptions) SetReportSettingID(reportSettingID string) *ScanSummariesOptions

SetReportSettingID : Allow user to set ReportSettingID

func (*ScanSummariesOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type ScansSummaryOptions

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

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

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

ScansSummaryOptions : The ScansSummary options.

func (*ScansSummaryOptions) SetAccountID

func (_options *ScansSummaryOptions) SetAccountID(accountID string) *ScansSummaryOptions

SetAccountID : Allow user to set AccountID

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 {
	// The ID of the scope.
	ID *string `json:"id" validate:"required"`

	// The name of the scope.
	Name *string `json:"name" validate:"required"`

	// The UUID of the scope. The unique user ID is displayed only when the value exists.
	UUID *string `json:"uuid,omitempty"`

	// The partner_uuid of the scope. The ID is displayed only when the value exists.
	PartnerUUID *string `json:"partner_uuid,omitempty"`

	// The description of the scope. The description is displayed only when the value exists.
	Description *string `json:"description,omitempty"`

	// The organization ID of the scope. The organization ID is displayed only when the value exists.
	OrgID *int64 `json:"org_id,omitempty"`

	// The cloud type ID of the scope. The ID is displayed only when the value exists.
	CloudTypeID *int64 `json:"cloud_type_id,omitempty"`

	// The credential ID of the scope. The ID is displayed only when the value exists.
	TldCredentialID *int64 `json:"tld_credential_id,omitempty"`

	// The status of the scope. The status is displayed only when the value exists.
	Status *string `json:"status,omitempty"`

	// The status message of the scope. The message is displayed only when the value exists.
	StatusMsg *string `json:"status_msg,omitempty"`

	// The subset-selected field of the scope. The field is displayed only when the value exists.
	SubsetSelected *bool `json:"subset_selected,omitempty"`

	// The enabled field of the scope. The field is displayed only when the value exists.
	Enabled *bool `json:"enabled,omitempty"`

	// The last discover start time of the scope. The time is displayed only when the value exists.
	LastDiscoverStartTime *string `json:"last_discover_start_time,omitempty"`

	// The last discover completed time of the scope. The time is displayed only when the value exists.
	LastDiscoverCompletedTime *string `json:"last_discover_completed_time,omitempty"`

	// The last successful discover start time of the scope. The time is displayed only when the value exists.
	LastSuccessfulDiscoverStartTime *string `json:"last_successful_discover_start_time,omitempty"`

	// The last successful discover completed time of the scope. The time is displayed only when the value exists.
	LastSuccessfulDiscoverCompletedTime *string `json:"last_successful_discover_completed_time,omitempty"`

	// The task type of the scope. The task type is displayed only when the value exists.
	TaskType *string `json:"task_type,omitempty"`

	// The tasks of the scope. The tasks are displayed only when the value exists.
	Tasks []ScopeDetailsGatewayTask `json:"tasks,omitempty"`

	// The status updated time of the scope. The time is displayed only when the value exists.
	StatusUpdatedTime *string `json:"status_updated_time,omitempty"`

	// The collectors by type of the scope. The collectors are displayed only when the values exist.
	CollectorsByType map[string][]Collector `json:"collectors_by_type,omitempty"`

	// The credentials by type of the scope. The credentials are displayed only when the values exist.
	CredentialsByType map[string][]ScopeDetailsCredential `json:"credentials_by_type,omitempty"`

	// The credentials by sub category type of the scope. The credentials are displayed only when the values exist.
	CredentialsBySubCategeoryType map[string][]ScopeDetailsCredential `json:"credentials_by_sub_categeory_type,omitempty"`

	// The sub categories by type of the scope. The categories are displayed only when the values exist.
	SubCategoriesByType map[string][]string `json:"sub_categories_by_type,omitempty"`

	// The resource groups of the scope. The resource groups are displayed only when the values exist.
	ResourceGroups *string `json:"resource_groups,omitempty"`

	// The region names of the scope. The names are displayed only when the values exist.
	RegionNames *string `json:"region_names,omitempty"`

	// The cloud type of the scope. The cloud type is displayed only when the value exists.
	CloudType *string `json:"cloud_type,omitempty"`

	// The env sub category of the scope. The category is displayed only when the value exists.
	EnvSubCategory *string `json:"env_sub_category,omitempty"`

	// The credential details of the scope.
	TldCredentail *ScopeDetailsCredential `json:"tld_credentail,omitempty"`

	// The collectors of the scope. The collectors are displayed only when the values exist.
	Collectors []Collector `json:"collectors,omitempty"`

	// The first-level scoped data of the scope. The data is displayed only when the value exists.
	FirstLevelScopedData []ScopeDetailsAssetData `json:"first_level_scoped_data,omitempty"`

	// The discovery methods of the scope. The methods are displayed only when the values exist.
	DiscoveryMethods []string `json:"discovery_methods,omitempty"`

	// The discovery method of the scope. The method is displayed only when the value exists.
	DiscoveryMethod *string `json:"discovery_method,omitempty"`

	// The file type of the scope. The type is displayed only when the value exists.
	FileType *string `json:"file_type,omitempty"`

	// The file format of the scope. The format is displayed only when the value exists.
	FileFormat *string `json:"file_format,omitempty"`

	// The user who created the scope. The user is displayed only when the value exists.
	CreatedBy *string `json:"created_by,omitempty"`

	// The date of creation of the scope. The date is displayed only when the value exists.
	CreatedAt *string `json:"created_at,omitempty"`

	// The user who modified the scope. The user is displayed only when the value exists.
	ModifiedBy *string `json:"modified_by,omitempty"`

	// The modified date of the scope. The date is displayed only when the value exists.
	ModifiedAt *string `json:"modified_at,omitempty"`

	// The scheduled discovery configuration of the scope. The data is displayed only when the value exists.
	IsDiscoveryScheduled *bool `json:"is_discovery_scheduled,omitempty"`

	// The interval of the scope. The interval is displayed only when the value exists.
	Interval *int64 `json:"interval,omitempty"`

	// The discovery setting ID of the scope. The ID is displayed only when the value exists.
	DiscoverySettingID *int64 `json:"discovery_setting_id,omitempty"`

	// The `include_new_eagerly` of the scope. The data is displayed only when the value exists.
	IncludeNewEagerly *bool `json:"include_new_eagerly,omitempty"`

	// The type of the scope. The type is displayed only when the value exists.
	Type *string `json:"type,omitempty"`

	// Get the status of a task such as discovery or validation. A correlation ID is created when a scope is created and
	// discovery or validation is triggered for a scope.
	CorrelationID *string `json:"correlation_id,omitempty"`

	// The credential attributes of the scope. The attributes are displayed only when the value exists.
	CredentialAttributes *string `json:"credential_attributes,omitempty"`
}

Scope : Get the details of the scope.

type ScopeCollector

type ScopeCollector struct {
	// The collector IDs of the scope.
	CollectorIds []string `json:"collector_ids" validate:"required"`
}

ScopeCollector : The collector details of the scope.

type ScopeCredential

type ScopeCredential struct {
	// The credential attribute of the scope.
	CredentialAttribute *string `json:"credential_attribute,omitempty"`

	// The credential ID of the scope.
	CredentialID *string `json:"credential_id" validate:"required"`
}

ScopeCredential : The details of the scope credential.

type ScopeDetailsAssetData

type ScopeDetailsAssetData struct {
	// The asset object of the scope.
	ScopeObject *string `json:"scope_object,omitempty"`

	// The initial value of the scope.
	ScopeInitScope *string `json:"scope_init_scope,omitempty"`

	// The asset of the scope.
	Scope *string `json:"scope,omitempty"`

	// The changed value of the scope.
	ScopeChanged *bool `json:"scope_changed,omitempty"`

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

	// The properties of the scope.
	ScopeProperties *string `json:"scope_properties,omitempty"`

	// The overlay of the scope.
	ScopeOverlay *string `json:"scope_overlay,omitempty"`

	// The newfound value of the scope.
	ScopeNewFound *bool `json:"scope_new_found,omitempty"`

	// The discovery status of the scope.
	ScopeDiscoveryStatus interface{} `json:"scope_discovery_status,omitempty"`

	// The fact status of the scope.
	ScopeFactStatus interface{} `json:"scope_fact_status,omitempty"`

	// The facts of the scope.
	ScopeFacts *string `json:"scope_facts,omitempty"`

	// The list members of the scope.
	ScopeListMembers interface{} `json:"scope_list_members,omitempty"`

	// The children of the scope.
	ScopeChildren interface{} `json:"scope_children,omitempty"`

	// The resource category of the scope.
	ScopeResourceCategory *string `json:"scope_resource_category,omitempty"`

	// The resource type of the scope.
	ScopeResourceType *string `json:"scope_resource_type,omitempty"`

	// The resource of the scope.
	ScopeResource *string `json:"scope_resource,omitempty"`

	// The resource attributes of the scope.
	ScopeResourceAttributes interface{} `json:"scope_resource_attributes,omitempty"`

	// The drift of the scope.
	ScopeDrift *string `json:"scope_drift,omitempty"`

	// The parse status of the scope.
	ScopeParseStatus *string `json:"scope_parse_status,omitempty"`

	// The transformed facts of the scope.
	ScopeTransformedFacts interface{} `json:"scope_transformed_facts,omitempty"`

	// The collector ID of the scope.
	ScopeCollectorID *int64 `json:"scope_collector_id,omitempty"`
}

ScopeDetailsAssetData : The asset data details of the scope.

type ScopeDetailsCredential

type ScopeDetailsCredential struct {
	// The credential ID of the scope.
	ID *string `json:"id,omitempty"`

	// The credential name of the scope.
	Name *string `json:"name,omitempty"`

	// The credential uuid of the scope.
	UUID *string `json:"uuid,omitempty"`

	// The credential type of the scope.
	Type *string `json:"type,omitempty"`

	// The credential data of the scope.
	Data interface{} `json:"data,omitempty"`

	// The display fields of the credential. The fields change based on the selected credential type.
	DisplayFields *ScopeDetailsCredentialDisplayFields `json:"display_fields,omitempty"`

	// The credential version timestamp of the scope.
	VersionTimestamp interface{} `json:"version_timestamp,omitempty"`

	// The credential description of the scope.
	Description *string `json:"description,omitempty"`

	// The configuration of whether the scope's credential is enabled.
	IsEnabled *bool `json:"is_enabled,omitempty"`

	// The credential gateway key of the scope.
	GatewayKey *string `json:"gateway_key,omitempty"`

	// The credential purpose of the scope.
	Purpose *string `json:"purpose,omitempty"`
}

ScopeDetailsCredential : The credential details of the scope.

type ScopeDetailsCredentialDisplayFields

type ScopeDetailsCredentialDisplayFields struct {
	// The IBM Cloud API Key. The API key is mandatory for the IBM Credential type.
	IBMAPIKey *string `json:"ibm_api_key,omitempty"`

	// The Amazon Web Services client ID. The client ID is mandatory when AWS Cloud is selected as the credential type.
	AwsClientID *string `json:"aws_client_id,omitempty"`

	// The Amazon Web Services client secret. The client secret is mandatory when AWS Cloud is selected as the credential
	// type.
	AwsClientSecret *string `json:"aws_client_secret,omitempty"`

	// The Amazon Web Services region. The region is used when AWS Cloud is selected as the credential type.
	AwsRegion *string `json:"aws_region,omitempty"`

	// The Amazon Web Services arn value. The arn value is used when AWS Cloud is selected as the credential type.
	AwsArn *string `json:"aws_arn,omitempty"`

	// The username of the user. The username is mandatory when the credential type is DataBase, Kerberos, OpenStack, and
	// Username-Password.
	Username *string `json:"username,omitempty"`

	// The password of the user. The password is mandatory when the credential type is DataBase, Kerberos, OpenStack, and
	// Username-Password.
	Password *string `json:"password,omitempty"`

	// The Microsoft Azure client ID. The client ID is mandatory when Azure is selected as the credential type.
	AzureClientID *string `json:"azure_client_id,omitempty"`

	// The Microsoft Azure client secret. The secret is mandatory when the type of credential is set to Azure.
	AzureClientSecret *string `json:"azure_client_secret,omitempty"`

	// The Microsoft Azure subscription ID. The subscription ID is mandatory when the type of credential is set to Azure.
	AzureSubscriptionID *string `json:"azure_subscription_id,omitempty"`

	// The Microsoft Azure resource group. The resource group is used when Azure is the credential type.
	AzureResourceGroup *string `json:"azure_resource_group,omitempty"`

	// The database name. The database name is mandatory when Database is the credential type.
	DatabaseName *string `json:"database_name,omitempty"`

	// The Kerberos Windows authentication type. The authentication type is mandatory when the credential type is Kerberos
	// Windows.
	WinrmAuthtype *string `json:"winrm_authtype,omitempty"`

	// The Kerberos Windows SSL. The SSL is mandatory when the credential type is Kerberos Windows.
	WinrmUsessl *string `json:"winrm_usessl,omitempty"`

	// The Kerberos Windows port. The port is mandatory When Kerberos Windows is the credential type.
	WinrmPort *string `json:"winrm_port,omitempty"`

	// The Microsoft 365 client ID. The client ID is mandatory when Microsoft 365 is the credential type.
	Ms365ClientID *string `json:"ms_365_client_id,omitempty"`

	// The Microsoft 365 client secret. The secret is mandatory when Microsoft 365 is the credential type.
	Ms365ClientSecret *string `json:"ms_365_client_secret,omitempty"`

	// The Microsoft 365 tenant ID. The tenant ID is mandatory when Microsoft 365 is the credential type.
	Ms365TenantID *string `json:"ms_365_tenant_id,omitempty"`

	// The auth url of the OpenStack cloud. The auth url is mandatory when OpenStack is the credential type.
	AuthURL *string `json:"auth_url,omitempty"`

	// The project name of the OpenStack cloud. The project name is mandatory when OpenStack is the credential type.
	ProjectName *string `json:"project_name,omitempty"`

	// The user domain name of the OpenStack cloud. The domain name is mandatory when OpenStack is the credential type.
	UserDomainName *string `json:"user_domain_name,omitempty"`

	// The project domain name of the OpenStack cloud. The project domain name is mandatory when OpenStack is the
	// credential type.
	ProjectDomainName *string `json:"project_domain_name,omitempty"`
}

ScopeDetailsCredentialDisplayFields : The display fields of the credential. The fields change based on the selected credential type.

type ScopeDetailsGatewayTask

type ScopeDetailsGatewayTask struct {
	// The task logs of the scope.
	TaskLogs []TaskLogs `json:"task_logs,omitempty"`

	// The task ID of the scope.
	TaskID *int64 `json:"task_id,omitempty"`

	// The task gateway ID of the scope.
	TaskGatewayID *int64 `json:"task_gateway_id,omitempty"`

	// The task gateway name of the scope.
	TaskGatewayName *string `json:"task_gateway_name,omitempty"`

	// The task type of the scope.
	TaskTaskType *string `json:"task_task_type,omitempty"`

	// The task gateway schema ID of the scope.
	TaskGatewaySchemaID *int64 `json:"task_gateway_schema_id,omitempty"`

	// The task schema name of the scope.
	TaskSchemaName *string `json:"task_schema_name,omitempty"`

	// The task-discover ID of the scope.
	TaskDiscoverID *int64 `json:"task_discover_id,omitempty"`

	// The task status of the scope.
	TaskStatus *string `json:"task_status,omitempty"`

	// The task status message of the scope.
	TaskStatusMsg *string `json:"task_status_msg,omitempty"`

	// The task start time of the scope.
	TaskStartTime *int64 `json:"task_start_time,omitempty"`

	// The task updated time of the scope.
	TaskUpdatedTime *int64 `json:"task_updated_time,omitempty"`

	// The task derived status of the scope.
	TaskDerivedStatus *string `json:"task_derived_status,omitempty"`

	// The user who created the task that is associated with scope.
	TaskCreatedBy *string `json:"task_created_by,omitempty"`
}

ScopeDetailsGatewayTask : The gateway task details of the scope.

type ScopeItem

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

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

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

	// An auto-generated unique identifier for the scope.
	ID *string `json:"id" validate:"required"`

	// The unique user ID of the scope.
	UUID *string `json:"uuid" validate:"required"`

	// A unique name for your scope.
	Name *string `json:"name" validate:"required"`

	// The scope is enabled or disabled.
	Enabled *bool `json:"enabled" validate:"required"`

	// The environment that the scope is targeted to.
	CredentialType *string `json:"credential_type" validate:"required"`

	// The time that the scope was created in UTC.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The time that the scope was last modified in UTC.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// The collectors of the scope. The collectors are displayed only when the values exist.
	Collectors []Collector `json:"collectors" validate:"required"`
}

ScopeItem : Scope.

type ScopeList

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

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

	// The total number of scopes. The value is 0 if no scopes are available. The detail fields are not available in that
	// case.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The URL of a page.
	First *PageLink `json:"first" validate:"required"`

	// The URL of a page.
	Last *PageLink `json:"last" validate:"required"`

	// The URL of a page.
	Previous *PageLink `json:"previous,omitempty"`

	// The URL of a page.
	Next *PageLink `json:"next,omitempty"`

	// Scopes.
	Scopes []ScopeItem `json:"scopes" validate:"required"`
}

ScopeList : Scopes list.

type ScopeTaskStatus

type ScopeTaskStatus struct {
	// The correlation ID.
	CorrelationID *string `json:"correlation_id" validate:"required"`

	// The status of a task.
	Status *string `json:"status" validate:"required"`

	// The time that the task started.
	StartTime *string `json:"start_time" validate:"required"`

	// The time that the scope was last updated. This value exists when a collector is installed and running.
	LastHeartbeat *strfmt.DateTime `json:"last_heartbeat" validate:"required"`
}

ScopeTaskStatus : Get the current task list for the collectors that are attached to the scope.

type Summary

type Summary struct {
	// The scan ID.
	ID *string `json:"id" validate:"required"`

	// The scan discovery ID.
	DiscoverID *string `json:"discover_id" validate:"required"`

	// The scan profile ID.
	ProfileID *string `json:"profile_id" validate:"required"`

	// The scan profile name.
	ProfileName *string `json:"profile_name" validate:"required"`

	// The scan summary scope ID.
	ScopeID *string `json:"scope_id" validate:"required"`

	// The list of controls that are on the scan summary.
	Controls []Control `json:"controls" validate:"required"`
}

Summary : A list of scans summary.

type SummaryItem

type SummaryItem struct {
	// The ID of the scan.
	ID *string `json:"id" validate:"required"`

	// A system-generated name that is the combination of 12 characters in the scope name and 12 characters in a profile
	// name.
	Name *string `json:"name" validate:"required"`

	// The ID of the scope.
	ScopeID *string `json:"scope_id" validate:"required"`

	// The name of the scope.
	ScopeName *string `json:"scope_name" validate:"required"`

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

	// The date and time that the scan was run.
	StartTime *strfmt.DateTime `json:"start_time" validate:"required"`

	// The date and time that the scan completed.
	EndTime *strfmt.DateTime `json:"end_time" validate:"required"`

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

	// The list of profiles.
	Profiles []ProfileResult `json:"profiles" validate:"required"`

	// The list of group profiles.
	GroupProfiles []ProfileResult `json:"group_profiles" validate:"required"`
}

SummaryItem : The result of a scan summary.

type SummaryList

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

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

	// The total number of scans that are available in the list of summaries.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The URL of a page.
	First *PageLink `json:"first" validate:"required"`

	// The URL of a page.
	Last *PageLink `json:"last" validate:"required"`

	// The URL of a page.
	Previous *PageLink `json:"previous,omitempty"`

	// The URL of a page.
	Next *PageLink `json:"next,omitempty"`

	// Summaries.
	Summaries []SummaryItem `json:"summaries" validate:"required"`
}

SummaryList : A list of scan summaries.

func (*SummaryList) GetNextOffset

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

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

type TaskLogs

type TaskLogs struct {
}

TaskLogs : The logs for the tasks that you ran.

type UpdateCollectorOptions

type UpdateCollectorOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

	// JSON Merge-Patch content for update_collector.
	Collector map[string]interface{} `json:"collector" validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

UpdateCollectorOptions : The UpdateCollector options.

func (*UpdateCollectorOptions) SetAccountID

func (_options *UpdateCollectorOptions) SetAccountID(accountID string) *UpdateCollectorOptions

SetAccountID : Allow user to set AccountID

func (*UpdateCollectorOptions) SetCollector

func (_options *UpdateCollectorOptions) SetCollector(collector map[string]interface{}) *UpdateCollectorOptions

SetCollector : Allow user to set Collector

func (*UpdateCollectorOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateCollectorOptions) SetID

SetID : Allow user to set ID

func (*UpdateCollectorOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

type UpdateCredentialDisplayFields

type UpdateCredentialDisplayFields struct {
	// The IBM Cloud API key. The API key is mandatory when IBM is the credential type.
	IBMAPIKey *string `json:"ibm_api_key,omitempty"`

	// The Amazon Web Services client ID. The client ID is mandatory when AWS Cloud is the credential type.
	AwsClientID *string `json:"aws_client_id,omitempty"`

	// The Amazon Web Services client secret. The secret is mandatory when AWS Cloud is the credential type.
	AwsClientSecret *string `json:"aws_client_secret,omitempty"`

	// The Amazon Web Services region. The region is mandatory when AWS Cloud is the credential type.
	AwsRegion *string `json:"aws_region,omitempty"`

	// The Amazon Web Services arn value. The arn value is mandatory when AWS Cloud is the credential type.
	AwsArn *string `json:"aws_arn,omitempty"`

	// The username of the user. The username is mandatory when the credential type is DataBase, Kerberos, or OpenStack.
	Username *string `json:"username,omitempty"`

	// The password of the user. The password is mandatory for DataBase, Kerberos, OpenStack credentials.
	Password *string `json:"password,omitempty"`

	// The Microsoft Azure client ID. The client ID is mandatory when Azure is the credential type.
	AzureClientID *string `json:"azure_client_id,omitempty"`

	// The Microsoft Azure client secret. The secret is mandatory when Azure is the credential type.
	AzureClientSecret *string `json:"azure_client_secret,omitempty"`

	// The Microsoft Azure subscription ID. The subscription ID is mandatory when Azure is the credential type.
	AzureSubscriptionID *string `json:"azure_subscription_id,omitempty"`

	// The Microsoft Azure resource group. The resource group is mandatory when Azure is the credential type.
	AzureResourceGroup *string `json:"azure_resource_group,omitempty"`

	// The Database name. The name is mandatory when Database is the credential type.
	DatabaseName *string `json:"database_name,omitempty"`

	// The Kerberos Windows auth type. The auth type is mandatory when Kerberos is the credential type.
	WinrmAuthtype *string `json:"winrm_authtype,omitempty"`

	// The Kerberos Windows SSL. The SSL is mandatory when Kerberos is the credential type.
	WinrmUsessl *string `json:"winrm_usessl,omitempty"`

	// The Kerberos Windows port. The port is mandatory when Kerberos is the credential type.
	WinrmPort *string `json:"winrm_port,omitempty"`

	// The Microsoft 365 client ID. The client ID is mandatory when Microsoft 365 is the credential type.
	Ms365ClientID *string `json:"ms_365_client_id,omitempty"`

	// The Microsoft 365 client secret. The secret is mandatory when Microsoft 365 is the credential type.
	Ms365ClientSecret *string `json:"ms_365_client_secret,omitempty"`

	// The Microsoft 365 tenant ID. The tenant ID is mandatory when Microsoft 365 is the credential type.
	Ms365TenantID *string `json:"ms_365_tenant_id,omitempty"`

	// The auth url of the OpenStack cloud. The auth url is mandatory when OpenStack is the credential type.
	AuthURL *string `json:"auth_url,omitempty"`

	// The project name of the OpenStack cloud. The project name is mandatory when OpenStack is the credential type.
	ProjectName *string `json:"project_name,omitempty"`

	// The user domain name of the OpenStack cloud. The domain name is mandatory when OpenStack is the credential type.
	UserDomainName *string `json:"user_domain_name,omitempty"`

	// The project domain name of the OpenStack cloud. The project domain name is mandatory when OpenStack is the
	// credential type.
	ProjectDomainName *string `json:"project_domain_name,omitempty"`

	// The user pem file name.
	PemFileName *string `json:"pem_file_name,omitempty"`

	// The base64 encoded form of pem.
	PemData *string `json:"pem_data,omitempty"`
}

UpdateCredentialDisplayFields : The details of the credential. The details change as the selected credential type varies.

type UpdateCredentialOptions

type UpdateCredentialOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

	// The status of the credential is enabled or disabled.
	Enabled *bool `json:"enabled,omitempty"`

	// The credential's type.
	Type *string `json:"type,omitempty"`

	// The credential's name.
	Name *string `json:"name,omitempty"`

	// The credential's description.
	Description *string `json:"description,omitempty"`

	// The details of the credential. The details change as the selected credential type varies.
	DisplayFields *UpdateCredentialDisplayFields `json:"display_fields,omitempty"`

	// The purpose for which the credential is created.
	Purpose *string `json:"purpose,omitempty"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

UpdateCredentialOptions : The UpdateCredential options.

func (*UpdateCredentialOptions) SetAccountID

func (_options *UpdateCredentialOptions) SetAccountID(accountID string) *UpdateCredentialOptions

SetAccountID : Allow user to set AccountID

func (*UpdateCredentialOptions) SetDescription

func (_options *UpdateCredentialOptions) SetDescription(description string) *UpdateCredentialOptions

SetDescription : Allow user to set Description

func (*UpdateCredentialOptions) SetDisplayFields

func (_options *UpdateCredentialOptions) SetDisplayFields(displayFields *UpdateCredentialDisplayFields) *UpdateCredentialOptions

SetDisplayFields : Allow user to set DisplayFields

func (*UpdateCredentialOptions) SetEnabled

func (_options *UpdateCredentialOptions) SetEnabled(enabled bool) *UpdateCredentialOptions

SetEnabled : Allow user to set Enabled

func (*UpdateCredentialOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateCredentialOptions) SetID

SetID : Allow user to set ID

func (*UpdateCredentialOptions) SetName

func (_options *UpdateCredentialOptions) SetName(name string) *UpdateCredentialOptions

SetName : Allow user to set Name

func (*UpdateCredentialOptions) SetPurpose

func (_options *UpdateCredentialOptions) SetPurpose(purpose string) *UpdateCredentialOptions

SetPurpose : Allow user to set Purpose

func (*UpdateCredentialOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

func (*UpdateCredentialOptions) SetType

func (_options *UpdateCredentialOptions) SetType(typeVar string) *UpdateCredentialOptions

SetType : Allow user to set Type

type UpdateProfilesOptions

type UpdateProfilesOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

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

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

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

	// The type of profile. Seed profiles have the type set as 'predefined' and user-generated profiles have the type set
	// as 'custom'.
	Type *string `json:"type,omitempty"`

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

	// A list of goal and control IDs that needs to be updated in the profile. These values can be retrieved from the
	// profiles/{profile_id}/controls API. The `profile_id` of the `base_profile` must be provided.
	ControlIds []string `json:"control_ids,omitempty"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

UpdateProfilesOptions : The UpdateProfiles options.

func (*UpdateProfilesOptions) SetAccountID

func (_options *UpdateProfilesOptions) SetAccountID(accountID string) *UpdateProfilesOptions

SetAccountID : Allow user to set AccountID

func (*UpdateProfilesOptions) SetBaseProfile

func (_options *UpdateProfilesOptions) SetBaseProfile(baseProfile string) *UpdateProfilesOptions

SetBaseProfile : Allow user to set BaseProfile

func (*UpdateProfilesOptions) SetControlIds

func (_options *UpdateProfilesOptions) SetControlIds(controlIds []string) *UpdateProfilesOptions

SetControlIds : Allow user to set ControlIds

func (*UpdateProfilesOptions) SetDescription

func (_options *UpdateProfilesOptions) SetDescription(description string) *UpdateProfilesOptions

SetDescription : Allow user to set Description

func (*UpdateProfilesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateProfilesOptions) SetID

func (_options *UpdateProfilesOptions) SetID(id string) *UpdateProfilesOptions

SetID : Allow user to set ID

func (*UpdateProfilesOptions) SetIsEnabled

func (_options *UpdateProfilesOptions) SetIsEnabled(isEnabled bool) *UpdateProfilesOptions

SetIsEnabled : Allow user to set IsEnabled

func (*UpdateProfilesOptions) SetName

func (_options *UpdateProfilesOptions) SetName(name string) *UpdateProfilesOptions

SetName : Allow user to set Name

func (*UpdateProfilesOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

func (*UpdateProfilesOptions) SetType

func (_options *UpdateProfilesOptions) SetType(typeVar string) *UpdateProfilesOptions

SetType : Allow user to set Type

type UpdateScopeDetailsOptions

type UpdateScopeDetailsOptions struct {
	// The ID for the API.
	ID *string `json:"-" validate:"required,ne="`

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

	// The description of the scope.
	Description *string `json:"description,omitempty"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"-"`

	// 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 `json:"-"`

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

UpdateScopeDetailsOptions : The UpdateScopeDetails options.

func (*UpdateScopeDetailsOptions) SetAccountID

func (_options *UpdateScopeDetailsOptions) SetAccountID(accountID string) *UpdateScopeDetailsOptions

SetAccountID : Allow user to set AccountID

func (*UpdateScopeDetailsOptions) SetDescription

func (_options *UpdateScopeDetailsOptions) SetDescription(description string) *UpdateScopeDetailsOptions

SetDescription : Allow user to set Description

func (*UpdateScopeDetailsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateScopeDetailsOptions) SetID

SetID : Allow user to set ID

func (*UpdateScopeDetailsOptions) SetName

SetName : Allow user to set Name

func (*UpdateScopeDetailsOptions) SetTransactionID

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

SetTransactionID : Allow user to set TransactionID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL