func GetDataVisibilityTlpNameEnumStringValues() []string
GetDataVisibilityTlpNameEnumStringValues Enumerates the set of values in String for DataVisibilityTlpNameEnum
func GetEntityReferenceTypeEnumStringValues() []string
GetEntityReferenceTypeEnumStringValues Enumerates the set of values in String for EntityReferenceTypeEnum
func GetIndicatorTypeEnumStringValues() []string
GetIndicatorTypeEnumStringValues Enumerates the set of values in String for IndicatorTypeEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListIndicatorCountsSortOrderEnumStringValues() []string
GetListIndicatorCountsSortOrderEnumStringValues Enumerates the set of values in String for ListIndicatorCountsSortOrderEnum
func GetListIndicatorsSortByEnumStringValues() []string
GetListIndicatorsSortByEnumStringValues Enumerates the set of values in String for ListIndicatorsSortByEnum
func GetListIndicatorsSortOrderEnumStringValues() []string
GetListIndicatorsSortOrderEnumStringValues Enumerates the set of values in String for ListIndicatorsSortOrderEnum
func GetListIndicatorsTypeEnumStringValues() []string
GetListIndicatorsTypeEnumStringValues Enumerates the set of values in String for ListIndicatorsTypeEnum
func GetListThreatTypesSortOrderEnumStringValues() []string
GetListThreatTypesSortOrderEnumStringValues Enumerates the set of values in String for ListThreatTypesSortOrderEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetSummarizeIndicatorsDetailsSortByEnumStringValues() []string
GetSummarizeIndicatorsDetailsSortByEnumStringValues Enumerates the set of values in String for SummarizeIndicatorsDetailsSortByEnum
DataAttribution The confidence, source information, and visibility for a particular sighting or observation of some data associated with a threat indicator. This associated data can be the indicator's threat type, attribute, or relationship.
type DataAttribution struct {
// An integer from 0 to 100 that provides a measure of our certainty in the maliciousness of data attributed to an indicator. For example, if the source of the data being attributed is the Tor Project, our confidence that the associated indicator is a tor exit node would be 100.
Confidence *int `mandatory:"true" json:"confidence"`
Source *IndicatorSourceSummary `mandatory:"true" json:"source"`
Visibility *DataVisibility `mandatory:"true" json:"visibility"`
// The last date and time the attribution data was seen for this entity. An RFC3339 formatted string.
TimeLastSeen *common.SDKTime `mandatory:"true" json:"timeLastSeen"`
// The date and time the attribution data was first seen for this entity. If the data source does not provide this information, it is set to the last time it was seen. An RFC3339 formatted string.
TimeFirstSeen *common.SDKTime `mandatory:"false" json:"timeFirstSeen"`
}
func (m DataAttribution) String() string
func (m DataAttribution) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataVisibility The visibility level of attribution data, including its Traffic Light Protocol (TLP) (https://www.cisa.gov/tlp) color.
type DataVisibility struct {
// The name of the visibility level.
Name *string `mandatory:"true" json:"name"`
// The Traffic Light Protocol (TLP) color of the visibility level.
TlpName DataVisibilityTlpNameEnum `mandatory:"true" json:"tlpName"`
}
func (m DataVisibility) String() string
func (m DataVisibility) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataVisibilityTlpNameEnum Enum with underlying type: string
type DataVisibilityTlpNameEnum string
Set of constants representing the allowable values for DataVisibilityTlpNameEnum
const (
DataVisibilityTlpNameInternalAudit DataVisibilityTlpNameEnum = "TLP_INTERNAL_AUDIT"
DataVisibilityTlpNameWhite DataVisibilityTlpNameEnum = "TLP_WHITE"
DataVisibilityTlpNameGreen DataVisibilityTlpNameEnum = "TLP_GREEN"
DataVisibilityTlpNameAmber DataVisibilityTlpNameEnum = "TLP_AMBER"
DataVisibilityTlpNameRed DataVisibilityTlpNameEnum = "TLP_RED"
)
func GetDataVisibilityTlpNameEnumValues() []DataVisibilityTlpNameEnum
GetDataVisibilityTlpNameEnumValues Enumerates the set of values for DataVisibilityTlpNameEnum
func GetMappingDataVisibilityTlpNameEnum(val string) (DataVisibilityTlpNameEnum, bool)
GetMappingDataVisibilityTlpNameEnum performs case Insensitive comparison on enum value and return the desired enum
EntityReference A reference to a resource or other entity.
type EntityReference interface {
}
EntityReferenceTypeEnum Enum with underlying type: string
type EntityReferenceTypeEnum string
Set of constants representing the allowable values for EntityReferenceTypeEnum
const (
EntityReferenceTypeIndicator EntityReferenceTypeEnum = "INDICATOR"
)
func GetEntityReferenceTypeEnumValues() []EntityReferenceTypeEnum
GetEntityReferenceTypeEnumValues Enumerates the set of values for EntityReferenceTypeEnum
func GetMappingEntityReferenceTypeEnum(val string) (EntityReferenceTypeEnum, bool)
GetMappingEntityReferenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GeodataDetails Geodata information for a given IP address
type GeodataDetails struct {
// ASN entry
Origin *string `mandatory:"true" json:"origin"`
// Two-letter abbreviation for country of origin
CountryCode *string `mandatory:"true" json:"countryCode"`
// State/Province/subdivision within the country
AdminDiv *string `mandatory:"true" json:"adminDiv"`
// City of origin
City *string `mandatory:"true" json:"city"`
// Latitude
Latitude *string `mandatory:"true" json:"latitude"`
// Longitude
Longitude *string `mandatory:"true" json:"longitude"`
// Information on source providing the information
Label *string `mandatory:"true" json:"label"`
// Encompassing assigned prefix for the IP
RoutedPrefix *string `mandatory:"false" json:"routedPrefix"`
// Unique Identifier (optional)
GeoId *string `mandatory:"false" json:"geoId"`
}
func (m GeodataDetails) String() string
func (m GeodataDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetIndicatorRequest wrapper for the GetIndicator operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/GetIndicator.go.html to see an example of how to use GetIndicatorRequest.
type GetIndicatorRequest struct {
// The unique identifier (OCID) of the threat indicator.
IndicatorId *string `mandatory:"true" contributesTo:"path" name:"indicatorId"`
// The OCID of the tenancy (root compartment) that is used to filter results.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetIndicatorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetIndicatorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetIndicatorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetIndicatorRequest) String() string
func (request GetIndicatorRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetIndicatorResponse wrapper for the GetIndicator operation
type GetIndicatorResponse struct {
// The underlying http response
RawResponse *http.Response
// The Indicator instance
Indicator `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetIndicatorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetIndicatorResponse) String() string
Indicator A data signature observed on a network or host that indicates a potential security threat. Indicators can be plain text or computed (hashed) values.
type Indicator struct {
// The OCID of the indicator.
Id *string `mandatory:"true" json:"id"`
// The type of indicator.
Type IndicatorTypeEnum `mandatory:"true" json:"type"`
// The value for this indicator.
// The value's format is dependent upon its `type`. Examples:
// DOMAIN_NAME "evil.example.com"
// MD5_HASH "44d88612fea8a8f36de82e1278abb02f"
// IP_ADDRESS "2001:db8::1"
Value *string `mandatory:"true" json:"value"`
// Characteristics of the threat indicator based on previous observations or behavior. May include related tactics, techniques, and procedures.
ThreatTypes []ThreatType `mandatory:"true" json:"threatTypes"`
// A map of attributes with additional information about the indicator.
// Each attribute has a name (string), value (string), and attribution (supporting data).
Attributes []IndicatorAttribute `mandatory:"true" json:"attributes"`
// A map of relationships between the indicator and other entities.
// Each relationship has a name (string), related entity, and attribution (supporting data).
Relationships []IndicatorRelationship `mandatory:"true" json:"relationships"`
// The date and time that the indicator was first detected. An RFC3339 formatted string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time that this indicator was last updated. The value is the same as `timeCreated` for a new indicator. An RFC3339 formatted string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The date and time that this indicator was last seen. The value is the same as `timeCreated` for a new indicator. An RFC3339 formatted string.
TimeLastSeen *common.SDKTime `mandatory:"true" json:"timeLastSeen"`
Geodata *GeodataDetails `mandatory:"true" json:"geodata"`
// An integer from 0 to 100 that represents how certain we are that the indicator is malicious and a potential threat if it is detected communicating with your cloud resources. This confidence value is aggregated from the confidence in the threat types, attributes, and relationships to create an overall value for the indicator.
Confidence *int `mandatory:"false" json:"confidence"`
// The OCID of the compartment that contains this indicator.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The state of the indicator. It will always be `ACTIVE`.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m Indicator) String() string
func (m Indicator) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorAttribute An attribute name and list of values with attribution.
type IndicatorAttribute struct {
// The name of the attribute.
Name *string `mandatory:"true" json:"name"`
// The value of the attribute.
Value *string `mandatory:"true" json:"value"`
// The array of attribution data that support this attribute.
Attribution []DataAttribution `mandatory:"true" json:"attribution"`
}
func (m IndicatorAttribute) String() string
func (m IndicatorAttribute) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorAttributeSummary An attribute name and list of values.
type IndicatorAttributeSummary struct {
// The name of the attribute.
Name *string `mandatory:"true" json:"name"`
// The value of the attribute.
Value *string `mandatory:"true" json:"value"`
}
func (m IndicatorAttributeSummary) String() string
func (m IndicatorAttributeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorCountCollection A list of indicator counts by indicator type.
type IndicatorCountCollection struct {
// The list of aggregated indicator counts.
Items []IndicatorCountSummary `mandatory:"true" json:"items"`
}
func (m IndicatorCountCollection) String() string
func (m IndicatorCountCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorCountDimensions The indicator dimension that was counted, such as the indicator type.
type IndicatorCountDimensions struct {
// The compartment OCID that contains the indicator type.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The indicator type that was counted.
Type IndicatorTypeEnum `mandatory:"false" json:"type,omitempty"`
}
func (m IndicatorCountDimensions) String() string
func (m IndicatorCountDimensions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorCountSummary A group of indicators with the same dimensions, such as the same indicator type.
type IndicatorCountSummary struct {
Dimensions *IndicatorCountDimensions `mandatory:"true" json:"dimensions"`
// The count of indicators in the group.
Count *int `mandatory:"true" json:"count"`
}
func (m IndicatorCountSummary) String() string
func (m IndicatorCountSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorReference A reference to a threat indicator resource.
type IndicatorReference struct {
// The unique OCID of the referenced threat indicator.
IndicatorId *string `mandatory:"true" json:"indicatorId"`
}
func (m IndicatorReference) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IndicatorReference) String() string
func (m IndicatorReference) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorRelationship A relationship name and list of releated entities.
type IndicatorRelationship struct {
// The name of the attribute.
Name *string `mandatory:"true" json:"name"`
RelatedEntity EntityReference `mandatory:"true" json:"relatedEntity"`
// The array of attribution data that support this relationship.
Attribution []DataAttribution `mandatory:"true" json:"attribution"`
}
func (m IndicatorRelationship) String() string
func (m *IndicatorRelationship) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m IndicatorRelationship) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorSourceSummary Information about the source of threat indicator data.
type IndicatorSourceSummary struct {
// The name of the source.
Name *string `mandatory:"true" json:"name"`
}
func (m IndicatorSourceSummary) String() string
func (m IndicatorSourceSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorSummary Summary of a data signature observed on a network or host that indicates a potential security threat.
type IndicatorSummary struct {
// The OCID of the indicator.
Id *string `mandatory:"true" json:"id"`
// The type of indicator.
Type IndicatorTypeEnum `mandatory:"true" json:"type"`
// The indicator data value.
Value *string `mandatory:"true" json:"value"`
// Characteristics of the threat indicator based on previous observations or behavior. May include related tactics, techniques, and procedures.
ThreatTypes []string `mandatory:"true" json:"threatTypes"`
// A map of attributes with additional information about the indicator.
// Each attribute has a name (string), value (string), and attribution (supporting data).
Attributes []IndicatorAttributeSummary `mandatory:"true" json:"attributes"`
// The date and time that the indicator was first detected. An RFC3339 formatted string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time that this indicator was last updated by the system. Updates can include new reports or regular updates in confidence. The value is the same as `timeCreated` for a new indicator. An RFC3339 formatted string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The date and time that this indicator was last seen. The value is the same as `timeCreated` for a new indicator. An RFC3339 formatted string.
TimeLastSeen *common.SDKTime `mandatory:"true" json:"timeLastSeen"`
Geodata *GeodataDetails `mandatory:"true" json:"geodata"`
// An integer from 0 to 100 that represents how certain we are that the indicator is malicious and a potential threat if it is detected communicating with your cloud resources. This confidence value is aggregated from the confidence in the threat types, attributes, and relationships to create an overall value for the indicator.
Confidence *int `mandatory:"false" json:"confidence"`
// The OCID of the compartment that contains this indicator.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The state of the indicator. It will always be `ACTIVE`.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m IndicatorSummary) String() string
func (m IndicatorSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorSummaryCollection List of indicator summary objects.
type IndicatorSummaryCollection struct {
// The list of indicator summaries.
Items []IndicatorSummary `mandatory:"true" json:"items"`
}
func (m IndicatorSummaryCollection) String() string
func (m IndicatorSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IndicatorTypeEnum Enum with underlying type: string
type IndicatorTypeEnum string
Set of constants representing the allowable values for IndicatorTypeEnum
const (
IndicatorTypeDomainName IndicatorTypeEnum = "DOMAIN_NAME"
IndicatorTypeFileName IndicatorTypeEnum = "FILE_NAME"
IndicatorTypeMd5Hash IndicatorTypeEnum = "MD5_HASH"
IndicatorTypeSha1Hash IndicatorTypeEnum = "SHA1_HASH"
IndicatorTypeSha256Hash IndicatorTypeEnum = "SHA256_HASH"
IndicatorTypeIpAddress IndicatorTypeEnum = "IP_ADDRESS"
IndicatorTypeUrl IndicatorTypeEnum = "URL"
)
func GetIndicatorTypeEnumValues() []IndicatorTypeEnum
GetIndicatorTypeEnumValues Enumerates the set of values for IndicatorTypeEnum
func GetMappingIndicatorTypeEnum(val string) (IndicatorTypeEnum, bool)
GetMappingIndicatorTypeEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListIndicatorCountsRequest wrapper for the ListIndicatorCounts operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListIndicatorCounts.go.html to see an example of how to use ListIndicatorCountsRequest.
type ListIndicatorCountsRequest struct {
// The OCID of the tenancy (root compartment) that is used to filter results.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListIndicatorCountsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListIndicatorCountsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIndicatorCountsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIndicatorCountsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIndicatorCountsRequest) String() string
func (request ListIndicatorCountsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListIndicatorCountsResponse wrapper for the ListIndicatorCounts operation
type ListIndicatorCountsResponse struct {
// The underlying http response
RawResponse *http.Response
// The IndicatorCountCollection instance
IndicatorCountCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListIndicatorCountsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIndicatorCountsResponse) String() string
ListIndicatorCountsSortOrderEnum Enum with underlying type: string
type ListIndicatorCountsSortOrderEnum string
Set of constants representing the allowable values for ListIndicatorCountsSortOrderEnum
const (
ListIndicatorCountsSortOrderAsc ListIndicatorCountsSortOrderEnum = "ASC"
ListIndicatorCountsSortOrderDesc ListIndicatorCountsSortOrderEnum = "DESC"
)
func GetListIndicatorCountsSortOrderEnumValues() []ListIndicatorCountsSortOrderEnum
GetListIndicatorCountsSortOrderEnumValues Enumerates the set of values for ListIndicatorCountsSortOrderEnum
func GetMappingListIndicatorCountsSortOrderEnum(val string) (ListIndicatorCountsSortOrderEnum, bool)
GetMappingListIndicatorCountsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListIndicatorsRequest wrapper for the ListIndicators operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListIndicators.go.html to see an example of how to use ListIndicatorsRequest.
type ListIndicatorsRequest struct {
// The OCID of the tenancy (root compartment) that is used to filter results.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The threat type of entites to be returned. To filter for multiple threat types, repeat this parameter.
ThreatTypeName []string `contributesTo:"query" name:"threatTypeName" collectionFormat:"multi"`
// The indicator type of entities to be returned.
Type ListIndicatorsTypeEnum `mandatory:"false" contributesTo:"query" name:"type" omitEmpty:"true"`
// The indicator value of entities to be returned.
Value *string `mandatory:"false" contributesTo:"query" name:"value"`
// The minimum confidence score of entities to be returned.
ConfidenceGreaterThanOrEqualTo *int `mandatory:"false" contributesTo:"query" name:"confidenceGreaterThanOrEqualTo"`
// The oldest update time of entities to be returned.
TimeUpdatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdatedGreaterThanOrEqualTo"`
// Return indicators updated before the provided time.
TimeUpdatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdatedLessThan"`
// The oldest last seen time of entities to be returned.
TimeLastSeenGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeLastSeenGreaterThanOrEqualTo"`
// Return indicators last seen before the provided time.
TimeLastSeenLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeLastSeenLessThan"`
// The oldest created/first seen time of entities to be returned.
TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"`
// Return indicators created/first seen before the provided time.
TimeCreatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThan"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListIndicatorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one field to sort by may be provided.
SortBy ListIndicatorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListIndicatorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIndicatorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIndicatorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIndicatorsRequest) String() string
func (request ListIndicatorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListIndicatorsResponse wrapper for the ListIndicators operation
type ListIndicatorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of IndicatorSummaryCollection instances
IndicatorSummaryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListIndicatorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIndicatorsResponse) String() string
ListIndicatorsSortByEnum Enum with underlying type: string
type ListIndicatorsSortByEnum string
Set of constants representing the allowable values for ListIndicatorsSortByEnum
const (
ListIndicatorsSortByConfidence ListIndicatorsSortByEnum = "confidence"
ListIndicatorsSortByTimecreated ListIndicatorsSortByEnum = "timeCreated"
ListIndicatorsSortByTimeupdated ListIndicatorsSortByEnum = "timeUpdated"
ListIndicatorsSortByTimelastseen ListIndicatorsSortByEnum = "timeLastSeen"
)
func GetListIndicatorsSortByEnumValues() []ListIndicatorsSortByEnum
GetListIndicatorsSortByEnumValues Enumerates the set of values for ListIndicatorsSortByEnum
func GetMappingListIndicatorsSortByEnum(val string) (ListIndicatorsSortByEnum, bool)
GetMappingListIndicatorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListIndicatorsSortOrderEnum Enum with underlying type: string
type ListIndicatorsSortOrderEnum string
Set of constants representing the allowable values for ListIndicatorsSortOrderEnum
const (
ListIndicatorsSortOrderAsc ListIndicatorsSortOrderEnum = "ASC"
ListIndicatorsSortOrderDesc ListIndicatorsSortOrderEnum = "DESC"
)
func GetListIndicatorsSortOrderEnumValues() []ListIndicatorsSortOrderEnum
GetListIndicatorsSortOrderEnumValues Enumerates the set of values for ListIndicatorsSortOrderEnum
func GetMappingListIndicatorsSortOrderEnum(val string) (ListIndicatorsSortOrderEnum, bool)
GetMappingListIndicatorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListIndicatorsTypeEnum Enum with underlying type: string
type ListIndicatorsTypeEnum string
Set of constants representing the allowable values for ListIndicatorsTypeEnum
const (
ListIndicatorsTypeDomainName ListIndicatorsTypeEnum = "DOMAIN_NAME"
ListIndicatorsTypeFileName ListIndicatorsTypeEnum = "FILE_NAME"
ListIndicatorsTypeMd5Hash ListIndicatorsTypeEnum = "MD5_HASH"
ListIndicatorsTypeSha1Hash ListIndicatorsTypeEnum = "SHA1_HASH"
ListIndicatorsTypeSha256Hash ListIndicatorsTypeEnum = "SHA256_HASH"
ListIndicatorsTypeIpAddress ListIndicatorsTypeEnum = "IP_ADDRESS"
ListIndicatorsTypeUrl ListIndicatorsTypeEnum = "URL"
)
func GetListIndicatorsTypeEnumValues() []ListIndicatorsTypeEnum
GetListIndicatorsTypeEnumValues Enumerates the set of values for ListIndicatorsTypeEnum
func GetMappingListIndicatorsTypeEnum(val string) (ListIndicatorsTypeEnum, bool)
GetMappingListIndicatorsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListThreatTypesRequest wrapper for the ListThreatTypes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListThreatTypes.go.html to see an example of how to use ListThreatTypesRequest.
type ListThreatTypesRequest struct {
// The OCID of the tenancy (root compartment) that is used to filter results.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListThreatTypesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListThreatTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListThreatTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListThreatTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListThreatTypesRequest) String() string
func (request ListThreatTypesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListThreatTypesResponse wrapper for the ListThreatTypes operation
type ListThreatTypesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ThreatTypesCollection instances
ThreatTypesCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListThreatTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListThreatTypesResponse) String() string
ListThreatTypesSortOrderEnum Enum with underlying type: string
type ListThreatTypesSortOrderEnum string
Set of constants representing the allowable values for ListThreatTypesSortOrderEnum
const (
ListThreatTypesSortOrderAsc ListThreatTypesSortOrderEnum = "ASC"
ListThreatTypesSortOrderDesc ListThreatTypesSortOrderEnum = "DESC"
)
func GetListThreatTypesSortOrderEnumValues() []ListThreatTypesSortOrderEnum
GetListThreatTypesSortOrderEnumValues Enumerates the set of values for ListThreatTypesSortOrderEnum
func GetMappingListThreatTypesSortOrderEnum(val string) (ListThreatTypesSortOrderEnum, bool)
GetMappingListThreatTypesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
SummarizeIndicatorsDetails Query parameters to filter indicators
type SummarizeIndicatorsDetails struct {
// The type of indicator this is
IndicatorType IndicatorTypeEnum `mandatory:"false" json:"indicatorType,omitempty"`
// The value for the type of indicator this is
IndicatorValue *string `mandatory:"false" json:"indicatorValue"`
// The threat type of entites to be returned.
ThreatTypes []string `mandatory:"false" json:"threatTypes"`
// The minimum level of confidence to return
ConfidenceGreaterThanOrEqualTo *int `mandatory:"false" json:"confidenceGreaterThanOrEqualTo"`
// The oldest update time of entities to be returned.
TimeUpdatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" json:"timeUpdatedGreaterThanOrEqualTo"`
// The newest update time of entities to be returned.
TimeUpdatedLessThan *common.SDKTime `mandatory:"false" json:"timeUpdatedLessThan"`
// The oldest last seen time of entities to be returned.
TimeLastSeenGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" json:"timeLastSeenGreaterThanOrEqualTo"`
// The newest last seen time of entities to be returned.
TimeLastSeenLessThan *common.SDKTime `mandatory:"false" json:"timeLastSeenLessThan"`
// The oldest creation time of entities to be returned.
TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" json:"timeCreatedGreaterThanOrEqualTo"`
// The newest creation time of entities to be returned.
TimeCreatedLessThan *common.SDKTime `mandatory:"false" json:"timeCreatedLessThan"`
// Filter to include indicators that have been seen by the provided source.
IndicatorSeenBy *string `mandatory:"false" json:"indicatorSeenBy"`
// Filter to include indicators associated with the provided malware.
Malware *string `mandatory:"false" json:"malware"`
// Filter to included indicators associated with the provided threat actor.
ThreatActor *string `mandatory:"false" json:"threatActor"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder SortOrderEnum `mandatory:"false" json:"sortOrder,omitempty"`
// The field to sort by. Only one field to sort by may be provided
SortBy SummarizeIndicatorsDetailsSortByEnum `mandatory:"false" json:"sortBy,omitempty"`
}
func (m SummarizeIndicatorsDetails) String() string
func (m SummarizeIndicatorsDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SummarizeIndicatorsDetailsSortByEnum Enum with underlying type: string
type SummarizeIndicatorsDetailsSortByEnum string
Set of constants representing the allowable values for SummarizeIndicatorsDetailsSortByEnum
const (
SummarizeIndicatorsDetailsSortByConfidence SummarizeIndicatorsDetailsSortByEnum = "CONFIDENCE"
SummarizeIndicatorsDetailsSortByTimecreated SummarizeIndicatorsDetailsSortByEnum = "TIMECREATED"
SummarizeIndicatorsDetailsSortByTimeupdated SummarizeIndicatorsDetailsSortByEnum = "TIMEUPDATED"
SummarizeIndicatorsDetailsSortByTimelastseen SummarizeIndicatorsDetailsSortByEnum = "TIMELASTSEEN"
)
func GetMappingSummarizeIndicatorsDetailsSortByEnum(val string) (SummarizeIndicatorsDetailsSortByEnum, bool)
GetMappingSummarizeIndicatorsDetailsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSummarizeIndicatorsDetailsSortByEnumValues() []SummarizeIndicatorsDetailsSortByEnum
GetSummarizeIndicatorsDetailsSortByEnumValues Enumerates the set of values for SummarizeIndicatorsDetailsSortByEnum
SummarizeIndicatorsRequest wrapper for the SummarizeIndicators operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/SummarizeIndicators.go.html to see an example of how to use SummarizeIndicatorsRequest.
type SummarizeIndicatorsRequest struct {
// The OCID of the tenancy (root compartment) that is used to filter results.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Query Parameters to search for indicators.
SummarizeIndicatorsDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request SummarizeIndicatorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SummarizeIndicatorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SummarizeIndicatorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SummarizeIndicatorsRequest) String() string
func (request SummarizeIndicatorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SummarizeIndicatorsResponse wrapper for the SummarizeIndicators operation
type SummarizeIndicatorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of IndicatorSummaryCollection instances
IndicatorSummaryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response SummarizeIndicatorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SummarizeIndicatorsResponse) String() string
ThreatType A threat type along with attribution data that associates it to a threat indicator.
type ThreatType struct {
// The OCID of the threat type.
Id *string `mandatory:"true" json:"id"`
// The name of the threat type.
Name *string `mandatory:"true" json:"name"`
// The list of supporting attribution information.
Attribution []DataAttribution `mandatory:"true" json:"attribution"`
}
func (m ThreatType) String() string
func (m ThreatType) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ThreatTypeSummary The name of a threat type and its ID.
type ThreatTypeSummary struct {
// The OCID of the threat type
Id *string `mandatory:"true" json:"id"`
// The name of the threat type
Name *string `mandatory:"true" json:"name"`
}
func (m ThreatTypeSummary) String() string
func (m ThreatTypeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ThreatTypesCollection List of threat types that can be associated with threat indicators.
type ThreatTypesCollection struct {
// The list of threat types that can be used to search for threat indicators.
Items []ThreatTypeSummary `mandatory:"true" json:"items"`
}
func (m ThreatTypesCollection) String() string
func (m ThreatTypesCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ThreatintelClient a client for Threatintel
type ThreatintelClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewThreatintelClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ThreatintelClient, err error)
NewThreatintelClientWithConfigurationProvider Creates a new default Threatintel client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewThreatintelClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ThreatintelClient, err error)
NewThreatintelClientWithOboToken Creates a new default Threatintel client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *ThreatintelClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ThreatintelClient) GetIndicator(ctx context.Context, request GetIndicatorRequest) (response GetIndicatorResponse, err error)
GetIndicator Get detailed information about a threat indicator with a given identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/GetIndicator.go.html to see an example of how to use GetIndicator API. A default retry strategy applies to this operation GetIndicator()
func (client ThreatintelClient) ListIndicatorCounts(ctx context.Context, request ListIndicatorCountsRequest) (response ListIndicatorCountsResponse, err error)
ListIndicatorCounts Get the current count of each threat indicator type. Indicator counts can be sorted in ascending or descending order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListIndicatorCounts.go.html to see an example of how to use ListIndicatorCounts API. A default retry strategy applies to this operation ListIndicatorCounts()
func (client ThreatintelClient) ListIndicators(ctx context.Context, request ListIndicatorsRequest) (response ListIndicatorsResponse, err error)
ListIndicators Get a list of threat indicator summaries based on the search criteria.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListIndicators.go.html to see an example of how to use ListIndicators API. A default retry strategy applies to this operation ListIndicators()
func (client ThreatintelClient) ListThreatTypes(ctx context.Context, request ListThreatTypesRequest) (response ListThreatTypesResponse, err error)
ListThreatTypes Gets a list of threat types that are available to use as parameters when querying indicators. The list is sorted by threat type name according to the sort order query param.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListThreatTypes.go.html to see an example of how to use ListThreatTypes API. A default retry strategy applies to this operation ListThreatTypes()
func (client *ThreatintelClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ThreatintelClient) SummarizeIndicators(ctx context.Context, request SummarizeIndicatorsRequest) (response SummarizeIndicatorsResponse, err error)
SummarizeIndicators Get indicator summaries based on advanced search criteria.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/SummarizeIndicators.go.html to see an example of how to use SummarizeIndicators API. A default retry strategy applies to this operation SummarizeIndicators()