- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- ThreatCollectionEntityMetadata
- ThreatCollectionEntityMetadataReference
- Try it!
Full name: projects.locations.instances.threatCollections.fetchEntityMetadata
Gets a list of entity metadata for a threat collection.
HTTP request
Path parameters
Parameters | |
---|---|
name |
Required. The resource name of the ThreatCollection to fetch entity metadata for. Format: projects/{project}/locations/{location}/instances/{instance}/threatCollections/{threatCollection} |
Query parameters
Parameters | |
---|---|
pageSize |
Optional. The page size for the number of entities to return. Default and maximum size is 1000. |
pageToken |
Optional. A page token, received from a previous |
Request body
The request body must be empty.
Response body
Response containing a list of entity metadata.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"entityMetadata": [
{
object ( |
Fields | |
---|---|
entityMetadata[] |
Output only. A list of entity risks scores with information typing them to the threat collection. Ordered by entity.risk_score. |
nextPageToken |
Output only. A token that can be sent as |
totalSize |
Output only. The total number of entities that match the request. The size of the |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name
resource:
chronicle.threatCollections.fetchEntityMetadata
For more information, see the IAM documentation.
ThreatCollectionEntityMetadata
Entity metadata for a threat collection.
JSON representation |
---|
{ "entity": { object ( |
Fields | |
---|---|
entity |
An Asset or User entity which contains an entity indicator and riskScore data associated with it. |
references[] |
A list of references associated with the entity. |
ThreatCollectionEntityMetadataReference
A link between a threat collection and an Asset or User entity in a threat collection's entity metadata.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field reference_type . Possible reference types. reference_type can be only one of the following: |
|
ioc |
The resource name of the Ioc associated with the entity. Format: projects/{project}/locations/{location}/instances/{instance}/iocs/{ioc} |