Method: uniqueEntities.list

Full name: projects.locations.instances.uniqueEntities.list

Lists UniqueEntities.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list UniqueEntities for. Format: projects/{project}/locations/{location}/instances/{instance}/uniqueEntities

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of UniqueEntities to return. The service may return fewer than this value. If unspecified, at most 50 UniqueEntities will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous uniqueEntities.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of UniqueEntities. Supported filter fields: * suspicious: Filter by the suspicious property. * enriched: Filter by the enriched property. * internalAsset: Filter by the internal asset property. * artifact: Filter by the artifact property. * manuallyCreated: Filter by the manually created property. * network: Filter by the network property. * additionalProperties: Filter by the additional properties. Example: filter="displayName='some_name'"
orderBy

string

Optional. Configures ordering of UniqueEntities in the response. If not specified, UniqueEntities are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. Supported sort fields: * uniqueEntityId * unique_entity_type * environment * creationTime * modificationTime * suspicious * enriched * internalAsset * artifact * manuallyCreated * network example: "uniqueEntityId desc, creationTime"

Request body

The request body must be empty.

Response body

Response message for uniqueEntities.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "uniqueEntities": [
    {
      object (UniqueEntity)
    }
  ],
  "nextPageToken": string
}
Fields
uniqueEntities[]

object (UniqueEntity)

Output only. The list of UniqueEntities.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.