Method: organizations.assets.list

Lists an organization's assets.

HTTP request

GET https://securitycenter.googleapis.com/v1beta1/{parent=organizations/*}/assets

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id]".

Query parameters

Parameters
filter

string

Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are not supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include:

  • name
  • securityCenterProperties.resource_name
  • resourceProperties.a_property
  • securityMarks.marks.marka

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.
  • integer literals without quotes.
  • boolean literals true and false without quotes.

For example, resourceProperties.size = 100 is a valid filter string.
orderBy

string

Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resourceProperties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resourceProperties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resourceProperties.a_property" and " name desc , resourceProperties.a_property " are equivalent.
readTime

string (Timestamp format)

Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
compareDuration

string (Duration format)

When compareDuration is set, the ListAssetResult's "state" attribute is updated to indicate whether the asset was added, removed, or remained present during the compareDuration period of time that precedes the readTime. This is the time between (readTime - compareDuration) and readTime.

The state value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again.

Possible "state" values when compareDuration is specified:

  • "ADDED": indicates that the asset was not present before compareDuration, but present at readTime.
  • "REMOVED": indicates that the asset was present at the start of compareDuration, but not present at readTime.
  • "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compareDuration and readTime.

If compareDuration is not specified, then the only possible state is "UNUSED", which indicates that the asset is present at readTime.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
fieldMask

string (FieldMask format)

Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.
pageToken

string

The value returned by the last ListAssetsResponse; indicates that this is a continuation of a prior assets.list call, and that the system should return the next page of data.
pageSize

integer

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Request body

The request body must be empty.

Response body

Response message for listing assets.

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

JSON representation 
{
  "listAssetsResults": [
    {
      object (ListAssetsResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string,
  "totalSize": integer
}
Fields
listAssetsResults[]

object (ListAssetsResult)

Assets matching the list request.
readTime

string (Timestamp format)

Time used for executing the list request.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results.
totalSize

integer

The total number of assets matching the query.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListAssetsResult

Result containing the Asset and its State.

JSON representation 
{
  "asset": {
    object (Asset)
  },
  "state": enum (State)
}
Fields
asset

object (Asset)

Asset matching the search request.
state

enum (State)

State of the asset.

Asset

Security Command Center representation of a Google Cloud resource.

The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.

JSON representation 
{
  "name": string,
  "securityCenterProperties": {
    object (SecurityCenterProperties)
  },
  "resourceProperties": {
    string: value,
    ...
  },
  "securityMarks": {
    object (SecurityMarks)
  },
  "createTime": string,
  "updateTime": string
}
Fields
name

string

The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/assets/{asset_id}".
securityCenterProperties

object (SecurityCenterProperties)

Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.
resourceProperties

map (key: string, value: value (Value format))

Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
securityMarks

object (SecurityMarks)

User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset.
createTime

string (Timestamp format)

The time at which the asset was created in Security Command Center.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

The time at which the asset was last updated, added, or deleted in Security Command Center.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

SecurityCenterProperties

Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.

JSON representation 
{
  "resourceName": string,
  "resourceType": string,
  "resourceParent": string,
  "resourceProject": string,
  "resourceOwners": [
    string
  ]
}
Fields
resourceName

string

Immutable. The full resource name of the Google Cloud resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
resourceType

string

The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Security Command Center and/or the producer of the resource and is immutable after create time.
resourceParent

string

The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
resourceProject

string

The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
resourceOwners[]

string

Owners of the Google Cloud resource.

State

State of the asset.

When querying across two points in time this describes the change between the two points: ADDED, REMOVED, or ACTIVE. If there was no compareDuration supplied in the request the state should be: UNUSED

Enums
STATE_UNSPECIFIED Unspecified state.
UNUSED Request did not specify use of this field in the result.
ADDED Asset was added between the points in time.
REMOVED Asset was removed between the points in time.
ACTIVE Asset was active at both point(s) in time.