Returns the findings Resource.
create(parent, body=None, x__xgafv=None)
Creates a source.
Gets a source.
getIamPolicy(resource, body=None, x__xgafv=None)
Gets the access control policy on the specified Source.
list(parent, pageToken=None, x__xgafv=None, pageSize=None)
Lists all sources belonging to an organization.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a source.
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified Source.
testIamPermissions(resource, body=None, x__xgafv=None)
Returns the permissions that a caller has on the specified source.
create(parent, body=None, x__xgafv=None)
Creates a source. Args: parent: string, Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". (required) body: object, The request body. The object takes the form of: { # Security Command Center finding source. A finding source # is an entity or a mechanism that can produce a finding. A source is like a # container of findings that come from the same scanner, logger, monitor, and # other tools. "displayName": "A String", # The source's display name. # A source's display name must be unique amongst its siblings, for example, # two sources with the same parent can't share the same display name. # The display name must have a length between 1 and 64 characters # (inclusive). "name": "A String", # The relative resource name of this source. See: # https://cloud.google.com/apis/design/resource_names#relative_resource_name # Example: # "organizations/{organization_id}/sources/{source_id}" "description": "A String", # The description of the source (max of 1024 characters). # Example: # "Web Security Scanner is a web security scanner for common # vulnerabilities in App Engine applications. It can automatically # scan and detect four common vulnerabilities, including cross-site-scripting # (XSS), Flash injection, mixed content (HTTP in HTTPS), and # outdated or insecure libraries." } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Security Command Center finding source. A finding source # is an entity or a mechanism that can produce a finding. A source is like a # container of findings that come from the same scanner, logger, monitor, and # other tools. "displayName": "A String", # The source's display name. # A source's display name must be unique amongst its siblings, for example, # two sources with the same parent can't share the same display name. # The display name must have a length between 1 and 64 characters # (inclusive). "name": "A String", # The relative resource name of this source. See: # https://cloud.google.com/apis/design/resource_names#relative_resource_name # Example: # "organizations/{organization_id}/sources/{source_id}" "description": "A String", # The description of the source (max of 1024 characters). # Example: # "Web Security Scanner is a web security scanner for common # vulnerabilities in App Engine applications. It can automatically # scan and detect four common vulnerabilities, including cross-site-scripting # (XSS), Flash injection, mixed content (HTTP in HTTPS), and # outdated or insecure libraries." }
get(name, x__xgafv=None)
Gets a source. Args: name: string, Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Security Command Center finding source. A finding source # is an entity or a mechanism that can produce a finding. A source is like a # container of findings that come from the same scanner, logger, monitor, and # other tools. "displayName": "A String", # The source's display name. # A source's display name must be unique amongst its siblings, for example, # two sources with the same parent can't share the same display name. # The display name must have a length between 1 and 64 characters # (inclusive). "name": "A String", # The relative resource name of this source. See: # https://cloud.google.com/apis/design/resource_names#relative_resource_name # Example: # "organizations/{organization_id}/sources/{source_id}" "description": "A String", # The description of the source (max of 1024 characters). # Example: # "Web Security Scanner is a web security scanner for common # vulnerabilities in App Engine applications. It can automatically # scan and detect four common vulnerabilities, including cross-site-scripting # (XSS), Flash injection, mixed content (HTTP in HTTPS), and # outdated or insecure libraries." }
getIamPolicy(resource, body=None, x__xgafv=None)
Gets the access control policy on the specified Source. Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) body: object, The request body. The object takes the form of: { # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to # `GetIamPolicy`. This field is only used by Cloud IAM. "requestedPolicyVersion": 42, # Optional. The policy format version to be returned. # # Valid values are 0, 1, and 3. Requests specifying an invalid value will be # rejected. # # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. }, } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # An Identity and Access Management (IAM) policy, which specifies access # controls for Google Cloud resources. # # # A `Policy` is a collection of `bindings`. A `binding` binds one or more # `members` to a single `role`. Members can be user accounts, service accounts, # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. # # Optionally, a `binding` can specify a `condition`, which is a logical # expression that allows access to a resource only if the expression evaluates # to `true`. A condition can add constraints based on attributes of the # request, the resource, or both. # # **JSON example:** # # { # "bindings": [ # { # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-project-id@appspot.gserviceaccount.com" # ] # }, # { # "role": "roles/resourcemanager.organizationViewer", # "members": ["user:eve@example.com"], # "condition": { # "title": "expirable access", # "description": "Does not grant access after Sep 2020", # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", # } # } # ], # "etag": "BwWWja0YfJA=", # "version": 3 # } # # **YAML example:** # # bindings: # - members: # - user:mike@example.com # - group:admins@example.com # - domain:google.com # - serviceAccount:my-project-id@appspot.gserviceaccount.com # role: roles/resourcemanager.organizationAdmin # - members: # - user:eve@example.com # role: roles/resourcemanager.organizationViewer # condition: # title: expirable access # description: Does not grant access after Sep 2020 # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') # - etag: BwWWja0YfJA= # - version: 3 # # For a description of IAM and its features, see the # [IAM documentation](https://cloud.google.com/iam/docs/). "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a # `condition` that determines how and when the `bindings` are applied. Each # of the `bindings` must contain at least one member. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. "members": [ # Specifies the identities requesting access for a Cloud Platform resource. # `members` can have the following values: # # * `allUsers`: A special identifier that represents anyone who is # on the internet; with or without a Google account. # # * `allAuthenticatedUsers`: A special identifier that represents anyone # who is authenticated with a Google account or a service account. # # * `user:{emailid}`: An email address that represents a specific Google # account. For example, `alice@example.com` . # # # * `serviceAccount:{emailid}`: An email address that represents a service # account. For example, `my-other-app@appspot.gserviceaccount.com`. # # * `group:{emailid}`: An email address that represents a Google group. # For example, `admins@example.com`. # # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique # identifier) representing a user that has been recently deleted. For # example, `alice@example.com?uid=123456789012345678901`. If the user is # recovered, this value reverts to `user:{emailid}` and the recovered user # retains the role in the binding. # # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus # unique identifier) representing a service account that has been recently # deleted. For example, # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. # If the service account is undeleted, this value reverts to # `serviceAccount:{emailid}` and the undeleted service account retains the # role in the binding. # # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique # identifier) representing a Google group that has been recently # deleted. For example, `admins@example.com?uid=123456789012345678901`. If # the group is recovered, this value reverts to `group:{emailid}` and the # recovered group retains the role in the binding. # # # * `domain:{domain}`: The G Suite domain (primary) that represents all the # users of that domain. For example, `google.com` or `example.com`. # "A String", ], "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. # NOTE: An unsatisfied condition will not allow user access via current # binding. Different bindings, including their conditions, are examined # independently. # syntax. CEL is a C-like expression language. The syntax and semantics of CEL # are documented at https://github.com/google/cel-spec. # # Example (Comparison): # # title: "Summary size limit" # description: "Determines if a summary is less than 100 chars" # expression: "document.summary.size() < 100" # # Example (Equality): # # title: "Requestor is owner" # description: "Determines if requestor is the document owner" # expression: "document.owner == request.auth.claims.email" # # Example (Logic): # # title: "Public documents" # description: "Determine whether the document should be publicly visible" # expression: "document.type != 'private' && document.type != 'internal'" # # Example (Data Manipulation): # # title: "Notification string" # description: "Create a notification string with a timestamp." # expression: "'New message received at ' + string(document.create_time)" # # The exact variables and functions that may be referenced within an expression # are determined by the service that evaluates it. See the service # documentation for additional information. "description": "A String", # Optional. Description of the expression. This is a longer text which # describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language # syntax. "location": "A String", # Optional. String indicating the location of the expression for error # reporting, e.g. a file name and a position in the file. "title": "A String", # Optional. Title for the expression, i.e. a short string describing # its purpose. This can be used e.g. in UIs which allow to enter the # expression. }, }, ], "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. { # Specifies the audit configuration for a service. # The configuration determines which permission types are logged, and what # identities, if any, are exempted from logging. # An AuditConfig must have one or more AuditLogConfigs. # # If there are AuditConfigs for both `allServices` and a specific service, # the union of the two AuditConfigs is used for that service: the log_types # specified in each AuditConfig are enabled, and the exempted_members in each # AuditLogConfig are exempted. # # Example Policy with multiple AuditConfigs: # # { # "audit_configs": [ # { # "service": "allServices" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:jose@example.com" # ] # }, # { # "log_type": "DATA_WRITE", # }, # { # "log_type": "ADMIN_READ", # } # ] # }, # { # "service": "sampleservice.googleapis.com" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # }, # { # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:aliya@example.com" # ] # } # ] # } # ] # } # # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts jose@example.com from DATA_READ logging, and # aliya@example.com from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. # Example: # # { # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:jose@example.com" # ] # }, # { # "log_type": "DATA_WRITE", # } # ] # } # # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. "A String", ], "logType": "A String", # The log type that this config enables. }, ], "service": "A String", # Specifies a service that will be enabled for audit logging. # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. # `allServices` is a special value that covers all services. }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help # prevent simultaneous updates of a policy from overwriting each other. # It is strongly suggested that systems make use of the `etag` in the # read-modify-write cycle to perform policy updates in order to avoid race # conditions: An `etag` is returned in the response to `getIamPolicy`, and # systems are expected to put that etag in the request to `setIamPolicy` to # ensure that their change will be applied to the same version of the policy. # # **Important:** If you use IAM Conditions, you must include the `etag` field # whenever you call `setIamPolicy`. If you omit this field, then IAM allows # you to overwrite a version `3` policy with a version `1` policy, and all of # the conditions in the version `3` policy are lost. "version": 42, # Specifies the format of the policy. # # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value # are rejected. # # Any operation that affects conditional role bindings must specify version # `3`. This requirement applies to the following operations: # # * Getting a policy that includes a conditional role binding # * Adding a conditional role binding to a policy # * Changing a conditional role binding in a policy # * Removing any role binding, with or without a condition, from a policy # that includes conditions # # **Important:** If you use IAM Conditions, you must include the `etag` field # whenever you call `setIamPolicy`. If you omit this field, then IAM allows # you to overwrite a version `3` policy with a version `1` policy, and all of # the conditions in the version `3` policy are lost. # # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. }
list(parent, pageToken=None, x__xgafv=None, pageSize=None)
Lists all sources belonging to an organization. Args: parent: string, Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". (required) pageToken: string, The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. Returns: An object of the form: { # Response message for listing sources. "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more # results. "sources": [ # Sources belonging to the requested parent. { # Security Command Center finding source. A finding source # is an entity or a mechanism that can produce a finding. A source is like a # container of findings that come from the same scanner, logger, monitor, and # other tools. "displayName": "A String", # The source's display name. # A source's display name must be unique amongst its siblings, for example, # two sources with the same parent can't share the same display name. # The display name must have a length between 1 and 64 characters # (inclusive). "name": "A String", # The relative resource name of this source. See: # https://cloud.google.com/apis/design/resource_names#relative_resource_name # Example: # "organizations/{organization_id}/sources/{source_id}" "description": "A String", # The description of the source (max of 1024 characters). # Example: # "Web Security Scanner is a web security scanner for common # vulnerabilities in App Engine applications. It can automatically # scan and detect four common vulnerabilities, including cross-site-scripting # (XSS), Flash injection, mixed content (HTTP in HTTPS), and # outdated or insecure libraries." }, ], }
list_next(previous_request, previous_response)
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a source. Args: name: string, The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" (required) body: object, The request body. The object takes the form of: { # Security Command Center finding source. A finding source # is an entity or a mechanism that can produce a finding. A source is like a # container of findings that come from the same scanner, logger, monitor, and # other tools. "displayName": "A String", # The source's display name. # A source's display name must be unique amongst its siblings, for example, # two sources with the same parent can't share the same display name. # The display name must have a length between 1 and 64 characters # (inclusive). "name": "A String", # The relative resource name of this source. See: # https://cloud.google.com/apis/design/resource_names#relative_resource_name # Example: # "organizations/{organization_id}/sources/{source_id}" "description": "A String", # The description of the source (max of 1024 characters). # Example: # "Web Security Scanner is a web security scanner for common # vulnerabilities in App Engine applications. It can automatically # scan and detect four common vulnerabilities, including cross-site-scripting # (XSS), Flash injection, mixed content (HTTP in HTTPS), and # outdated or insecure libraries." } updateMask: string, The FieldMask to use when updating the source resource. If empty all mutable fields will be updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Security Command Center finding source. A finding source # is an entity or a mechanism that can produce a finding. A source is like a # container of findings that come from the same scanner, logger, monitor, and # other tools. "displayName": "A String", # The source's display name. # A source's display name must be unique amongst its siblings, for example, # two sources with the same parent can't share the same display name. # The display name must have a length between 1 and 64 characters # (inclusive). "name": "A String", # The relative resource name of this source. See: # https://cloud.google.com/apis/design/resource_names#relative_resource_name # Example: # "organizations/{organization_id}/sources/{source_id}" "description": "A String", # The description of the source (max of 1024 characters). # Example: # "Web Security Scanner is a web security scanner for common # vulnerabilities in App Engine applications. It can automatically # scan and detect four common vulnerabilities, including cross-site-scripting # (XSS), Flash injection, mixed content (HTTP in HTTPS), and # outdated or insecure libraries." }
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified Source. Args: resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) body: object, The request body. The object takes the form of: { # Request message for `SetIamPolicy` method. "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of # the policy is limited to a few 10s of KB. An empty policy is a # valid policy but certain Cloud Platform services (such as Projects) # might reject them. # controls for Google Cloud resources. # # # A `Policy` is a collection of `bindings`. A `binding` binds one or more # `members` to a single `role`. Members can be user accounts, service accounts, # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. # # Optionally, a `binding` can specify a `condition`, which is a logical # expression that allows access to a resource only if the expression evaluates # to `true`. A condition can add constraints based on attributes of the # request, the resource, or both. # # **JSON example:** # # { # "bindings": [ # { # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-project-id@appspot.gserviceaccount.com" # ] # }, # { # "role": "roles/resourcemanager.organizationViewer", # "members": ["user:eve@example.com"], # "condition": { # "title": "expirable access", # "description": "Does not grant access after Sep 2020", # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", # } # } # ], # "etag": "BwWWja0YfJA=", # "version": 3 # } # # **YAML example:** # # bindings: # - members: # - user:mike@example.com # - group:admins@example.com # - domain:google.com # - serviceAccount:my-project-id@appspot.gserviceaccount.com # role: roles/resourcemanager.organizationAdmin # - members: # - user:eve@example.com # role: roles/resourcemanager.organizationViewer # condition: # title: expirable access # description: Does not grant access after Sep 2020 # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') # - etag: BwWWja0YfJA= # - version: 3 # # For a description of IAM and its features, see the # [IAM documentation](https://cloud.google.com/iam/docs/). "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a # `condition` that determines how and when the `bindings` are applied. Each # of the `bindings` must contain at least one member. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. "members": [ # Specifies the identities requesting access for a Cloud Platform resource. # `members` can have the following values: # # * `allUsers`: A special identifier that represents anyone who is # on the internet; with or without a Google account. # # * `allAuthenticatedUsers`: A special identifier that represents anyone # who is authenticated with a Google account or a service account. # # * `user:{emailid}`: An email address that represents a specific Google # account. For example, `alice@example.com` . # # # * `serviceAccount:{emailid}`: An email address that represents a service # account. For example, `my-other-app@appspot.gserviceaccount.com`. # # * `group:{emailid}`: An email address that represents a Google group. # For example, `admins@example.com`. # # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique # identifier) representing a user that has been recently deleted. For # example, `alice@example.com?uid=123456789012345678901`. If the user is # recovered, this value reverts to `user:{emailid}` and the recovered user # retains the role in the binding. # # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus # unique identifier) representing a service account that has been recently # deleted. For example, # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. # If the service account is undeleted, this value reverts to # `serviceAccount:{emailid}` and the undeleted service account retains the # role in the binding. # # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique # identifier) representing a Google group that has been recently # deleted. For example, `admins@example.com?uid=123456789012345678901`. If # the group is recovered, this value reverts to `group:{emailid}` and the # recovered group retains the role in the binding. # # # * `domain:{domain}`: The G Suite domain (primary) that represents all the # users of that domain. For example, `google.com` or `example.com`. # "A String", ], "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. # NOTE: An unsatisfied condition will not allow user access via current # binding. Different bindings, including their conditions, are examined # independently. # syntax. CEL is a C-like expression language. The syntax and semantics of CEL # are documented at https://github.com/google/cel-spec. # # Example (Comparison): # # title: "Summary size limit" # description: "Determines if a summary is less than 100 chars" # expression: "document.summary.size() < 100" # # Example (Equality): # # title: "Requestor is owner" # description: "Determines if requestor is the document owner" # expression: "document.owner == request.auth.claims.email" # # Example (Logic): # # title: "Public documents" # description: "Determine whether the document should be publicly visible" # expression: "document.type != 'private' && document.type != 'internal'" # # Example (Data Manipulation): # # title: "Notification string" # description: "Create a notification string with a timestamp." # expression: "'New message received at ' + string(document.create_time)" # # The exact variables and functions that may be referenced within an expression # are determined by the service that evaluates it. See the service # documentation for additional information. "description": "A String", # Optional. Description of the expression. This is a longer text which # describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language # syntax. "location": "A String", # Optional. String indicating the location of the expression for error # reporting, e.g. a file name and a position in the file. "title": "A String", # Optional. Title for the expression, i.e. a short string describing # its purpose. This can be used e.g. in UIs which allow to enter the # expression. }, }, ], "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. { # Specifies the audit configuration for a service. # The configuration determines which permission types are logged, and what # identities, if any, are exempted from logging. # An AuditConfig must have one or more AuditLogConfigs. # # If there are AuditConfigs for both `allServices` and a specific service, # the union of the two AuditConfigs is used for that service: the log_types # specified in each AuditConfig are enabled, and the exempted_members in each # AuditLogConfig are exempted. # # Example Policy with multiple AuditConfigs: # # { # "audit_configs": [ # { # "service": "allServices" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:jose@example.com" # ] # }, # { # "log_type": "DATA_WRITE", # }, # { # "log_type": "ADMIN_READ", # } # ] # }, # { # "service": "sampleservice.googleapis.com" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # }, # { # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:aliya@example.com" # ] # } # ] # } # ] # } # # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts jose@example.com from DATA_READ logging, and # aliya@example.com from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. # Example: # # { # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:jose@example.com" # ] # }, # { # "log_type": "DATA_WRITE", # } # ] # } # # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. "A String", ], "logType": "A String", # The log type that this config enables. }, ], "service": "A String", # Specifies a service that will be enabled for audit logging. # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. # `allServices` is a special value that covers all services. }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help # prevent simultaneous updates of a policy from overwriting each other. # It is strongly suggested that systems make use of the `etag` in the # read-modify-write cycle to perform policy updates in order to avoid race # conditions: An `etag` is returned in the response to `getIamPolicy`, and # systems are expected to put that etag in the request to `setIamPolicy` to # ensure that their change will be applied to the same version of the policy. # # **Important:** If you use IAM Conditions, you must include the `etag` field # whenever you call `setIamPolicy`. If you omit this field, then IAM allows # you to overwrite a version `3` policy with a version `1` policy, and all of # the conditions in the version `3` policy are lost. "version": 42, # Specifies the format of the policy. # # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value # are rejected. # # Any operation that affects conditional role bindings must specify version # `3`. This requirement applies to the following operations: # # * Getting a policy that includes a conditional role binding # * Adding a conditional role binding to a policy # * Changing a conditional role binding in a policy # * Removing any role binding, with or without a condition, from a policy # that includes conditions # # **Important:** If you use IAM Conditions, you must include the `etag` field # whenever you call `setIamPolicy`. If you omit this field, then IAM allows # you to overwrite a version `3` policy with a version `1` policy, and all of # the conditions in the version `3` policy are lost. # # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. }, "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: # paths: "bindings, etag" # This field is only used by Cloud IAM. } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # An Identity and Access Management (IAM) policy, which specifies access # controls for Google Cloud resources. # # # A `Policy` is a collection of `bindings`. A `binding` binds one or more # `members` to a single `role`. Members can be user accounts, service accounts, # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. # # Optionally, a `binding` can specify a `condition`, which is a logical # expression that allows access to a resource only if the expression evaluates # to `true`. A condition can add constraints based on attributes of the # request, the resource, or both. # # **JSON example:** # # { # "bindings": [ # { # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-project-id@appspot.gserviceaccount.com" # ] # }, # { # "role": "roles/resourcemanager.organizationViewer", # "members": ["user:eve@example.com"], # "condition": { # "title": "expirable access", # "description": "Does not grant access after Sep 2020", # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", # } # } # ], # "etag": "BwWWja0YfJA=", # "version": 3 # } # # **YAML example:** # # bindings: # - members: # - user:mike@example.com # - group:admins@example.com # - domain:google.com # - serviceAccount:my-project-id@appspot.gserviceaccount.com # role: roles/resourcemanager.organizationAdmin # - members: # - user:eve@example.com # role: roles/resourcemanager.organizationViewer # condition: # title: expirable access # description: Does not grant access after Sep 2020 # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') # - etag: BwWWja0YfJA= # - version: 3 # # For a description of IAM and its features, see the # [IAM documentation](https://cloud.google.com/iam/docs/). "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a # `condition` that determines how and when the `bindings` are applied. Each # of the `bindings` must contain at least one member. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. "members": [ # Specifies the identities requesting access for a Cloud Platform resource. # `members` can have the following values: # # * `allUsers`: A special identifier that represents anyone who is # on the internet; with or without a Google account. # # * `allAuthenticatedUsers`: A special identifier that represents anyone # who is authenticated with a Google account or a service account. # # * `user:{emailid}`: An email address that represents a specific Google # account. For example, `alice@example.com` . # # # * `serviceAccount:{emailid}`: An email address that represents a service # account. For example, `my-other-app@appspot.gserviceaccount.com`. # # * `group:{emailid}`: An email address that represents a Google group. # For example, `admins@example.com`. # # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique # identifier) representing a user that has been recently deleted. For # example, `alice@example.com?uid=123456789012345678901`. If the user is # recovered, this value reverts to `user:{emailid}` and the recovered user # retains the role in the binding. # # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus # unique identifier) representing a service account that has been recently # deleted. For example, # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. # If the service account is undeleted, this value reverts to # `serviceAccount:{emailid}` and the undeleted service account retains the # role in the binding. # # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique # identifier) representing a Google group that has been recently # deleted. For example, `admins@example.com?uid=123456789012345678901`. If # the group is recovered, this value reverts to `group:{emailid}` and the # recovered group retains the role in the binding. # # # * `domain:{domain}`: The G Suite domain (primary) that represents all the # users of that domain. For example, `google.com` or `example.com`. # "A String", ], "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. # NOTE: An unsatisfied condition will not allow user access via current # binding. Different bindings, including their conditions, are examined # independently. # syntax. CEL is a C-like expression language. The syntax and semantics of CEL # are documented at https://github.com/google/cel-spec. # # Example (Comparison): # # title: "Summary size limit" # description: "Determines if a summary is less than 100 chars" # expression: "document.summary.size() < 100" # # Example (Equality): # # title: "Requestor is owner" # description: "Determines if requestor is the document owner" # expression: "document.owner == request.auth.claims.email" # # Example (Logic): # # title: "Public documents" # description: "Determine whether the document should be publicly visible" # expression: "document.type != 'private' && document.type != 'internal'" # # Example (Data Manipulation): # # title: "Notification string" # description: "Create a notification string with a timestamp." # expression: "'New message received at ' + string(document.create_time)" # # The exact variables and functions that may be referenced within an expression # are determined by the service that evaluates it. See the service # documentation for additional information. "description": "A String", # Optional. Description of the expression. This is a longer text which # describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language # syntax. "location": "A String", # Optional. String indicating the location of the expression for error # reporting, e.g. a file name and a position in the file. "title": "A String", # Optional. Title for the expression, i.e. a short string describing # its purpose. This can be used e.g. in UIs which allow to enter the # expression. }, }, ], "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. { # Specifies the audit configuration for a service. # The configuration determines which permission types are logged, and what # identities, if any, are exempted from logging. # An AuditConfig must have one or more AuditLogConfigs. # # If there are AuditConfigs for both `allServices` and a specific service, # the union of the two AuditConfigs is used for that service: the log_types # specified in each AuditConfig are enabled, and the exempted_members in each # AuditLogConfig are exempted. # # Example Policy with multiple AuditConfigs: # # { # "audit_configs": [ # { # "service": "allServices" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:jose@example.com" # ] # }, # { # "log_type": "DATA_WRITE", # }, # { # "log_type": "ADMIN_READ", # } # ] # }, # { # "service": "sampleservice.googleapis.com" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # }, # { # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:aliya@example.com" # ] # } # ] # } # ] # } # # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts jose@example.com from DATA_READ logging, and # aliya@example.com from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. # Example: # # { # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:jose@example.com" # ] # }, # { # "log_type": "DATA_WRITE", # } # ] # } # # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. "A String", ], "logType": "A String", # The log type that this config enables. }, ], "service": "A String", # Specifies a service that will be enabled for audit logging. # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. # `allServices` is a special value that covers all services. }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help # prevent simultaneous updates of a policy from overwriting each other. # It is strongly suggested that systems make use of the `etag` in the # read-modify-write cycle to perform policy updates in order to avoid race # conditions: An `etag` is returned in the response to `getIamPolicy`, and # systems are expected to put that etag in the request to `setIamPolicy` to # ensure that their change will be applied to the same version of the policy. # # **Important:** If you use IAM Conditions, you must include the `etag` field # whenever you call `setIamPolicy`. If you omit this field, then IAM allows # you to overwrite a version `3` policy with a version `1` policy, and all of # the conditions in the version `3` policy are lost. "version": 42, # Specifies the format of the policy. # # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value # are rejected. # # Any operation that affects conditional role bindings must specify version # `3`. This requirement applies to the following operations: # # * Getting a policy that includes a conditional role binding # * Adding a conditional role binding to a policy # * Changing a conditional role binding in a policy # * Removing any role binding, with or without a condition, from a policy # that includes conditions # # **Important:** If you use IAM Conditions, you must include the `etag` field # whenever you call `setIamPolicy`. If you omit this field, then IAM allows # you to overwrite a version `3` policy with a version `1` policy, and all of # the conditions in the version `3` policy are lost. # # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. }
testIamPermissions(resource, body=None, x__xgafv=None)
Returns the permissions that a caller has on the specified source. Args: resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required) body: object, The request body. The object takes the form of: { # Request message for `TestIamPermissions` method. "permissions": [ # The set of permissions to check for the `resource`. Permissions with # wildcards (such as '*' or 'storage.*') are not allowed. For more # information see # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). "A String", ], } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Response message for `TestIamPermissions` method. "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is # allowed. "A String", ], }