Reference documentation and code samples for the Cloud Asset V1 API class Google::Cloud::Asset::V1::SearchAllIamPoliciesRequest.
Search all IAM policies request.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#asset_types
def asset_types() -> ::Array<::String>
-
(::Array<::String>) — Optional. A list of asset types that the IAM policies are attached to. If
empty, it will search the IAM policies that are attached to all the
searchable asset
types.
Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots IAM policies attached to asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots IAM policies attached to asset type ends with "Instance".
- ".Instance." snapshots IAM policies attached to asset type contains "Instance".
See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
#asset_types=
def asset_types=(value) -> ::Array<::String>
-
value (::Array<::String>) — Optional. A list of asset types that the IAM policies are attached to. If
empty, it will search the IAM policies that are attached to all the
searchable asset
types.
Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots IAM policies attached to asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots IAM policies attached to asset type ends with "Instance".
- ".Instance." snapshots IAM policies attached to asset type contains "Instance".
See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
-
(::Array<::String>) — Optional. A list of asset types that the IAM policies are attached to. If
empty, it will search the IAM policies that are attached to all the
searchable asset
types.
Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots IAM policies attached to asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots IAM policies attached to asset type ends with "Instance".
- ".Instance." snapshots IAM policies attached to asset type contains "Instance".
See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
#order_by
def order_by() -> ::String
-
(::String) —
Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "assetType DESC, resource". Only singular primitive fields in the response are sortable:
- resource
- assetType
- project
All the other fields such as repeated fields (e.g.,
folders
) and non-primitive fields (e.g.,policy
) are not supported.
#order_by=
def order_by=(value) -> ::String
-
value (::String) —
Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "assetType DESC, resource". Only singular primitive fields in the response are sortable:
- resource
- assetType
- project
All the other fields such as repeated fields (e.g.,
folders
) and non-primitive fields (e.g.,policy
) are not supported.
-
(::String) —
Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "assetType DESC, resource". Only singular primitive fields in the response are sortable:
- resource
- assetType
- project
All the other fields such as repeated fields (e.g.,
folders
) and non-primitive fields (e.g.,policy
) are not supported.
#page_size
def page_size() -> ::Integer
-
(::Integer) — 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_size=
def page_size=(value) -> ::Integer
-
value (::Integer) — 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.
-
(::Integer) — 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
def page_token() -> ::String
-
(::String) — Optional. If present, retrieve the next batch of results from the preceding
call to this method.
page_token
must be the value ofnext_page_token
from the previous response. The values of all other method parameters must be identical to those in the previous call.
#page_token=
def page_token=(value) -> ::String
-
value (::String) — Optional. If present, retrieve the next batch of results from the preceding
call to this method.
page_token
must be the value ofnext_page_token
from the previous response. The values of all other method parameters must be identical to those in the previous call.
-
(::String) — Optional. If present, retrieve the next batch of results from the preceding
call to this method.
page_token
must be the value ofnext_page_token
from the previous response. The values of all other method parameters must be identical to those in the previous call.
#query
def query() -> ::String
-
(::String) —
Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the IAM policies within the specified
scope
. Note that the query string is compared against each Cloud IAM policy binding, including its principals, roles, and Cloud IAM conditions. The returned Cloud IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see the IAM policy documentation.Examples:
policy:amy@gmail.com
to find IAM policy bindings that specify user "amy@gmail.com".policy:roles/compute.admin
to find IAM policy bindings that specify the Compute Admin role.policy:comp*
to find IAM policy bindings that contain "comp" as a prefix of any word in the binding.policy.role.permissions:storage.buckets.update
to find IAM policy bindings that specify a role containing "storage.buckets.update" permission. Note that if callers don't haveiam.roles.get
access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.policy.role.permissions:upd*
to find IAM policy bindings that specify a role containing "upd" as a prefix of any word in the role permission. Note that if callers don't haveiam.roles.get
access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.resource:organizations/123456
to find IAM policy bindings that are set on "organizations/123456".resource=//cloudresourcemanager.googleapis.com/projects/myproject
to find IAM policy bindings that are set on the project named "myproject".Important
to find IAM policy bindings that contain "Important" as a word in any of the searchable fields (except for the included permissions).resource:(instance1 OR instance2) policy:amy
to find IAM policy bindings that are set on resources "instance1" or "instance2" and also specify user "amy".roles:roles/compute.admin
to find IAM policy bindings that specify the Compute Admin role.memberTypes:user
to find IAM policy bindings that contain the principal type "user".
#query=
def query=(value) -> ::String
-
value (::String) —
Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the IAM policies within the specified
scope
. Note that the query string is compared against each Cloud IAM policy binding, including its principals, roles, and Cloud IAM conditions. The returned Cloud IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see the IAM policy documentation.Examples:
policy:amy@gmail.com
to find IAM policy bindings that specify user "amy@gmail.com".policy:roles/compute.admin
to find IAM policy bindings that specify the Compute Admin role.policy:comp*
to find IAM policy bindings that contain "comp" as a prefix of any word in the binding.policy.role.permissions:storage.buckets.update
to find IAM policy bindings that specify a role containing "storage.buckets.update" permission. Note that if callers don't haveiam.roles.get
access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.policy.role.permissions:upd*
to find IAM policy bindings that specify a role containing "upd" as a prefix of any word in the role permission. Note that if callers don't haveiam.roles.get
access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.resource:organizations/123456
to find IAM policy bindings that are set on "organizations/123456".resource=//cloudresourcemanager.googleapis.com/projects/myproject
to find IAM policy bindings that are set on the project named "myproject".Important
to find IAM policy bindings that contain "Important" as a word in any of the searchable fields (except for the included permissions).resource:(instance1 OR instance2) policy:amy
to find IAM policy bindings that are set on resources "instance1" or "instance2" and also specify user "amy".roles:roles/compute.admin
to find IAM policy bindings that specify the Compute Admin role.memberTypes:user
to find IAM policy bindings that contain the principal type "user".
-
(::String) —
Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the IAM policies within the specified
scope
. Note that the query string is compared against each Cloud IAM policy binding, including its principals, roles, and Cloud IAM conditions. The returned Cloud IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see the IAM policy documentation.Examples:
policy:amy@gmail.com
to find IAM policy bindings that specify user "amy@gmail.com".policy:roles/compute.admin
to find IAM policy bindings that specify the Compute Admin role.policy:comp*
to find IAM policy bindings that contain "comp" as a prefix of any word in the binding.policy.role.permissions:storage.buckets.update
to find IAM policy bindings that specify a role containing "storage.buckets.update" permission. Note that if callers don't haveiam.roles.get
access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.policy.role.permissions:upd*
to find IAM policy bindings that specify a role containing "upd" as a prefix of any word in the role permission. Note that if callers don't haveiam.roles.get
access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.resource:organizations/123456
to find IAM policy bindings that are set on "organizations/123456".resource=//cloudresourcemanager.googleapis.com/projects/myproject
to find IAM policy bindings that are set on the project named "myproject".Important
to find IAM policy bindings that contain "Important" as a word in any of the searchable fields (except for the included permissions).resource:(instance1 OR instance2) policy:amy
to find IAM policy bindings that are set on resources "instance1" or "instance2" and also specify user "amy".roles:roles/compute.admin
to find IAM policy bindings that specify the Compute Admin role.memberTypes:user
to find IAM policy bindings that contain the principal type "user".
#scope
def scope() -> ::String
-
(::String) —
Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the
scope
. The caller must be granted thecloudasset.assets.searchAllIamPolicies
permission on the desired scope.The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
#scope=
def scope=(value) -> ::String
-
value (::String) —
Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the
scope
. The caller must be granted thecloudasset.assets.searchAllIamPolicies
permission on the desired scope.The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
-
(::String) —
Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the
scope
. The caller must be granted thecloudasset.assets.searchAllIamPolicies
permission on the desired scope.The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")