Package google.cloud.asset.v1p1beta1

Index

AssetService

Asset service definition.

SearchAllIamPolicies

rpc SearchAllIamPolicies(SearchAllIamPoliciesRequest) returns (SearchAllIamPoliciesResponse)

Searches all the IAM policies under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the IAM policies under a scope, even if they don't have .getIamPolicy permission of all the IAM policies. Callers should have cloud.assets.SearchAllIamPolicies permission on the requested scope, otherwise it will be rejected.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

SearchAllResources

rpc SearchAllResources(SearchAllResourcesRequest) returns (SearchAllResourcesResponse)

Searches all the resources under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the resources under a scope, even if they don't have .get permission of all the resources. Callers should have cloud.assets.SearchAllResources permission on the requested scope, otherwise it will be rejected.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IamPolicySearchResult

The result for a IAM Policy search.

Fields
resource

string

The full resource name of the resource associated with this IAM policy.

project

string

The project that the associated GCP resource belongs to, in the form of projects/{project_number}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, the project field will be empty.

policy

Policy

Representation of the actual Cloud IAM policy set on a cloud resource. For each resource, there must be at most one Cloud IAM policy set on it.

SearchAllIamPoliciesRequest

Search all IAM policies request.

Fields
scope

string

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be: * Organization number (such as "organizations/123") * Folder number(such as "folders/1234") * Project number (such as "projects/12345")

Authorization requires the following Google IAM permission on the specified resource scope:

  • cloudasset.assets.searchAllIamPolicies
query

string

Optional. The query statement. Examples: * "policy:myuser@mydomain.com" * "policy:(myuser@mydomain.com viewer)"

page_size

int32

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

page_token

string

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

SearchAllIamPoliciesResponse

Search all IAM policies response.

Fields
results[]

IamPolicySearchResult

A list of IamPolicy that match the search query. Related information such as the associated resource is returned along with the policy.

next_page_token

string

Set if there are more results than those appearing in this response; to get the next set of results, call this method again, using this value as the page_token.

SearchAllResourcesRequest

Search all resources request.

Fields
scope

string

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be: * Organization number (such as "organizations/123") * Folder number(such as "folders/1234") * Project number (such as "projects/12345")

Authorization requires the following Google IAM permission on the specified resource scope:

  • cloudasset.assets.searchAllResources
query

string

Optional. The query statement.

asset_types[]

string

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

page_size

int32

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters, must be identical to those in the previous call.

SearchAllResourcesResponse

Search all resources response.

Fields
results[]

StandardResourceMetadata

A list of resource that match the search query.

next_page_token

string

If there are more results than those appearing in this response, then next_page_token is included. To get the next set of results, call this method again using the value of next_page_token as page_token.

StandardResourceMetadata

The standard metadata of a cloud resource.

Fields
name

string

The full resource name. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Resource Names for more information.

asset_type

string

The type of this resource. For example: "compute.googleapis.com/Disk".

project

string

The project that this resource belongs to, in the form of projects/{project_number}.

display_name

string

The display name of this resource.

description

string

One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes.

additional_attributes[]

string

Additional searchable attributes of this resource. Informational only. The exact set of attributes is subject to change. For example: project id, DNS name etc.