threatintelligence

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"`
}

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"`
}

type DataVisibilityTlpNameEnum string

type EntityReference interface {
}

type EntityReferenceTypeEnum string

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"`
}

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
}

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"`
}

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"`
}

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"`
}

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"`
}

type IndicatorCountCollection struct {

	// The list of aggregated indicator counts.
	Items []IndicatorCountSummary `mandatory:"true" json:"items"`
}

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"`
}

type IndicatorCountSummary struct {
	Dimensions *IndicatorCountDimensions `mandatory:"true" json:"dimensions"`

	// The count of indicators in the group.
	Count *int `mandatory:"true" json:"count"`
}

type IndicatorReference struct {

	// The unique OCID of the referenced threat indicator.
	IndicatorId *string `mandatory:"true" json:"indicatorId"`
}

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"`
}

type IndicatorSourceSummary struct {

	// The name of the source.
	Name *string `mandatory:"true" json:"name"`
}

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"`
}

type IndicatorSummaryCollection struct {

	// The list of indicator summaries.
	Items []IndicatorSummary `mandatory:"true" json:"items"`
}

type IndicatorTypeEnum string

type LifecycleStateEnum string

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
}

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"`
}

type ListIndicatorCountsSortOrderEnum string

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
}

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"`
}

type ListIndicatorsSortByEnum string

type ListIndicatorsSortOrderEnum string

type ListIndicatorsTypeEnum string

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
}

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"`
}

type ListThreatTypesSortOrderEnum string

type SortOrderEnum string

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"`
}

type SummarizeIndicatorsDetailsSortByEnum string

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
}

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"`
}

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"`
}

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"`
}

type ThreatTypesCollection struct {

	// The list of threat types that can be used to search for threat indicators.
	Items []ThreatTypeSummary `mandatory:"true" json:"items"`
}

type ThreatintelClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}