Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 48f503fbae07b4b80773f526c16ea30e0e65806b / . / docs / dyn / iap_v1.v1.html
blob: 45766a310bb3862aaa9133aa7b010ff75f95c5b5 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="iap_v1.html">Cloud Identity-Aware Proxy API</a> . <a href="iap_v1.v1.html">v1</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for an Identity-Aware Proxy protected</p>
<p class="toc_element">
<code><a href="#getIapSettings">getIapSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the IAP settings on a particular IAP protected resource.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy for an Identity-Aware Proxy protected</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the Identity-Aware Proxy protected</p>
<p class="toc_element">
<code><a href="#updateIapSettings">updateIapSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the IAP settings on a particular IAP protected resource. It</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Gets the access control policy for an Identity-Aware Proxy protected
resource.
More information about managing access via IAP can be found at:
https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api
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 &lt; 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 &lt; 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() &lt; 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' &amp;&amp; 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.
},
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="getIapSettings">getIapSettings(name, x__xgafv=None)</code>
<pre>Gets the IAP settings on a particular IAP protected resource.
Args:
name: string, Required. The resource name for which to retrieve the settings.
Authorization: Requires the `getSettings` permission for the associated
resource. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The IAP configurable settings.
"applicationSettings": { # Wrapper over application specific settings for IAP. # Top level wrapper for all application related settings in IAP
"accessDeniedPageSettings": { # Custom content configuration for access denied page. # Customization for Access Denied page.
# IAP allows customers to define a custom URI to use as the error page when
# access is denied to users. If IAP prevents access to this page, the default
# IAP error page will be displayed instead.
"accessDeniedPageUri": "A String", # The URI to be redirected to when access is denied.
},
"csmSettings": { # Configuration for RCTokens generated for CSM workloads protected by IAP. # Settings to configure IAP's behavior for a CSM mesh.
# RCTokens are IAP generated JWTs that can be verified at the application. The
# RCToken is primarily used for ISTIO deployments, and can be scoped to a
# single mesh by configuring the audience field accordingly
"rctokenAud": "A String", # Audience claim set in the generated RCToken. This value is not validated by
# IAP.
},
},
"accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
"oauthSettings": { # Configuration for OAuth login&amp;consent flow behavior as well as for OAuth # Settings to configure IAP's OAuth behavior.
# Credentials.
"loginHint": "A String", # Domain hint to send as hd=? parameter in OAuth request flow. Enables
# redirect to primary IDP by skipping Google's login screen.
# https://developers.google.com/identity/protocols/OpenIDConnect#hd-param
# Note: IAP does not verify that the id token's hd claim matches this value
# since access behavior is managed by IAM policies.
"clientId": "A String", # OAuth 2.0 client ID used in the OAuth flow to generate an access token. If
# this field is set, you can skip obtaining the OAuth credentials in this
# step:
# https://developers.google.com/identity/protocols/OAuth2?hl=en_US#1.-obtain-oauth-2.0-credentials-from-the-google-api-console.
# However, this could allow for client sharing. The risks of client sharing
# are outlined here:
# https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.
},
"corsSettings": { # Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS # Configuration to allow cross-origin requests via IAP.
# call to bypass authentication and authorization.
"allowHttpOptions": True or False, # Configuration to allow HTTP OPTIONS calls to skip authorization. If
# undefined, IAP will not apply any special logic to OPTIONS requests.
},
"policyDelegationSettings": { # PolicyDelegationConfig allows google-internal teams to use IAP for apps # Settings to configure Policy delegation for apps hosted in tenant projects.
# INTERNAL_ONLY.
# hosted in a tenant project. Using these settings, the app can delegate
# permission check to happen against the linked customer project.
# This is only ever supposed to be used by google internal teams, hence the
# restriction on the proto.
"policyName": { # Policy name to be checked
"region": "A String", # For Cloud IAM:
# The location of the Policy.
# Must be empty or "global" for Policies owned by global IAM. Must name a
# region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see
# http://go/iam-faq#where-is-iam-currently-deployed.
#
# For Local IAM:
# This field should be set to "local".
"type": "A String", # Valid values for type might be 'gce', 'gcs', 'project', 'account' etc.
"id": "A String",
},
"iamPermission": "A String", # Permission to check in IAM.
"resource": { # IAM resource to check permission on
"labels": { # The service defined labels of the resource on which the conditions will be
# evaluated. The semantics - including the key names - are vague to IAM.
# If the effective condition has a reference to a `resource.labels[foo]`
# construct, IAM consults with this map to retrieve the values associated
# with `foo` key for Conditions evaluation. If the provided key is not found
# in the labels map, the condition would evaluate to false.
#
# This field is in limited use. If your intended use case is not expected
# to express resource.labels attribute in IAM Conditions, leave this field
# empty. Before planning on using this attribute please:
# * Read go/iam-conditions-labels-comm and ensure your service can meet the
# data availability and management requirements.
# * Talk to iam-conditions-eng@ about your use case.
"a_key": "A String",
},
"type": "A String", # The public resource type name of the resource on which conditions will be
# evaluated. It is configured using the official_name of the ResourceType as
# defined in service configurations under //configs/cloud/resourcetypes.
# For example, the official_name for GCP projects is set as
# 'cloudresourcemanager.googleapis.com/Project' according to
# //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml
# For details see go/iam-conditions-integration-guide.
"name": "A String", # Name of the resource on which conditions will be evaluated.
# Must use the Relative Resource Name of the resource, which is the URI
# path of the resource without the leading "/". Examples are
# "projects/_/buckets/[BUCKET-ID]" for storage buckets or
# "projects/[PROJECT-ID]/global/firewalls/[FIREWALL-ID]" for a firewall.
#
# This field is required for evaluating conditions with rules on resource
# names. For a `list` permission check, the resource.name value must be set
# to the parent resource. If the parent resource is a project, this field
# should be left unset.
"service": "A String", # The name of the service this resource belongs to. It is configured using
# the official_service_name of the Service as defined in service
# configurations under //configs/cloud/resourcetypes.
# For example, the official_service_name of cloud resource manager service
# is set as 'cloudresourcemanager.googleapis.com' according to
# //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml
},
"iamServiceName": "A String", # The DNS name of the service (e.g. "resourcemanager.googleapis.com").
# This should be the domain name part of the full resource names (see
# https://aip.dev/122#full-resource-names), which is usually
# the same as IamServiceSpec.service of the service where the resource type
# is defined.
},
"gcipSettings": { # Allows customers to configure tenant_id for GCIP instance per-app. # GCIP claims and endpoint configurations for 3p identity providers.
"loginPageUri": "A String", # Login page URI associated with the GCIP tenants.
# Typically, all resources within the same project share the same login page,
# though it could be overridden at the sub resource level.
"tenantIds": [ # GCIP tenant ids that are linked to the IAP resource.
# tenant_ids could be a string beginning with a number character to indicate
# authenticating with GCIP tenant flow, or in the format of _&lt;ProjectNumber&gt;
# to indicate authenticating with GCIP agent flow.
# If agent flow is used, tenant_ids should only contain one single element,
# while for tenant flow, tenant_ids can contain multiple elements.
"A String",
],
},
},
"name": "A String", # Required. The resource name of the IAP protected resource.
}</pre>
</div>
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the access control policy for an Identity-Aware Proxy protected
resource. Replaces any existing policy.
More information about managing access via IAP can be found at:
https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api
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 &lt; 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 &lt; 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() &lt; 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' &amp;&amp; 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.
},
},
],
"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.
},
}
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 &lt; 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 &lt; 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() &lt; 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' &amp;&amp; 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.
},
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Returns permissions that a caller has on the Identity-Aware Proxy protected
resource.
More information about managing access via IAP can be found at:
https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api
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",
],
}</pre>
</div>
<div class="method">
<code class="details" id="updateIapSettings">updateIapSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the IAP settings on a particular IAP protected resource. It
replaces all fields unless the `update_mask` is set.
Args:
name: string, Required. The resource name of the IAP protected resource. (required)
body: object, The request body.
The object takes the form of:
{ # The IAP configurable settings.
"applicationSettings": { # Wrapper over application specific settings for IAP. # Top level wrapper for all application related settings in IAP
"accessDeniedPageSettings": { # Custom content configuration for access denied page. # Customization for Access Denied page.
# IAP allows customers to define a custom URI to use as the error page when
# access is denied to users. If IAP prevents access to this page, the default
# IAP error page will be displayed instead.
"accessDeniedPageUri": "A String", # The URI to be redirected to when access is denied.
},
"csmSettings": { # Configuration for RCTokens generated for CSM workloads protected by IAP. # Settings to configure IAP's behavior for a CSM mesh.
# RCTokens are IAP generated JWTs that can be verified at the application. The
# RCToken is primarily used for ISTIO deployments, and can be scoped to a
# single mesh by configuring the audience field accordingly
"rctokenAud": "A String", # Audience claim set in the generated RCToken. This value is not validated by
# IAP.
},
},
"accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
"oauthSettings": { # Configuration for OAuth login&amp;consent flow behavior as well as for OAuth # Settings to configure IAP's OAuth behavior.
# Credentials.
"loginHint": "A String", # Domain hint to send as hd=? parameter in OAuth request flow. Enables
# redirect to primary IDP by skipping Google's login screen.
# https://developers.google.com/identity/protocols/OpenIDConnect#hd-param
# Note: IAP does not verify that the id token's hd claim matches this value
# since access behavior is managed by IAM policies.
"clientId": "A String", # OAuth 2.0 client ID used in the OAuth flow to generate an access token. If
# this field is set, you can skip obtaining the OAuth credentials in this
# step:
# https://developers.google.com/identity/protocols/OAuth2?hl=en_US#1.-obtain-oauth-2.0-credentials-from-the-google-api-console.
# However, this could allow for client sharing. The risks of client sharing
# are outlined here:
# https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.
},
"corsSettings": { # Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS # Configuration to allow cross-origin requests via IAP.
# call to bypass authentication and authorization.
"allowHttpOptions": True or False, # Configuration to allow HTTP OPTIONS calls to skip authorization. If
# undefined, IAP will not apply any special logic to OPTIONS requests.
},
"policyDelegationSettings": { # PolicyDelegationConfig allows google-internal teams to use IAP for apps # Settings to configure Policy delegation for apps hosted in tenant projects.
# INTERNAL_ONLY.
# hosted in a tenant project. Using these settings, the app can delegate
# permission check to happen against the linked customer project.
# This is only ever supposed to be used by google internal teams, hence the
# restriction on the proto.
"policyName": { # Policy name to be checked
"region": "A String", # For Cloud IAM:
# The location of the Policy.
# Must be empty or "global" for Policies owned by global IAM. Must name a
# region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see
# http://go/iam-faq#where-is-iam-currently-deployed.
#
# For Local IAM:
# This field should be set to "local".
"type": "A String", # Valid values for type might be 'gce', 'gcs', 'project', 'account' etc.
"id": "A String",
},
"iamPermission": "A String", # Permission to check in IAM.
"resource": { # IAM resource to check permission on
"labels": { # The service defined labels of the resource on which the conditions will be
# evaluated. The semantics - including the key names - are vague to IAM.
# If the effective condition has a reference to a `resource.labels[foo]`
# construct, IAM consults with this map to retrieve the values associated
# with `foo` key for Conditions evaluation. If the provided key is not found
# in the labels map, the condition would evaluate to false.
#
# This field is in limited use. If your intended use case is not expected
# to express resource.labels attribute in IAM Conditions, leave this field
# empty. Before planning on using this attribute please:
# * Read go/iam-conditions-labels-comm and ensure your service can meet the
# data availability and management requirements.
# * Talk to iam-conditions-eng@ about your use case.
"a_key": "A String",
},
"type": "A String", # The public resource type name of the resource on which conditions will be
# evaluated. It is configured using the official_name of the ResourceType as
# defined in service configurations under //configs/cloud/resourcetypes.
# For example, the official_name for GCP projects is set as
# 'cloudresourcemanager.googleapis.com/Project' according to
# //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml
# For details see go/iam-conditions-integration-guide.
"name": "A String", # Name of the resource on which conditions will be evaluated.
# Must use the Relative Resource Name of the resource, which is the URI
# path of the resource without the leading "/". Examples are
# "projects/_/buckets/[BUCKET-ID]" for storage buckets or
# "projects/[PROJECT-ID]/global/firewalls/[FIREWALL-ID]" for a firewall.
#
# This field is required for evaluating conditions with rules on resource
# names. For a `list` permission check, the resource.name value must be set
# to the parent resource. If the parent resource is a project, this field
# should be left unset.
"service": "A String", # The name of the service this resource belongs to. It is configured using
# the official_service_name of the Service as defined in service
# configurations under //configs/cloud/resourcetypes.
# For example, the official_service_name of cloud resource manager service
# is set as 'cloudresourcemanager.googleapis.com' according to
# //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml
},
"iamServiceName": "A String", # The DNS name of the service (e.g. "resourcemanager.googleapis.com").
# This should be the domain name part of the full resource names (see
# https://aip.dev/122#full-resource-names), which is usually
# the same as IamServiceSpec.service of the service where the resource type
# is defined.
},
"gcipSettings": { # Allows customers to configure tenant_id for GCIP instance per-app. # GCIP claims and endpoint configurations for 3p identity providers.
"loginPageUri": "A String", # Login page URI associated with the GCIP tenants.
# Typically, all resources within the same project share the same login page,
# though it could be overridden at the sub resource level.
"tenantIds": [ # GCIP tenant ids that are linked to the IAP resource.
# tenant_ids could be a string beginning with a number character to indicate
# authenticating with GCIP tenant flow, or in the format of _&lt;ProjectNumber&gt;
# to indicate authenticating with GCIP agent flow.
# If agent flow is used, tenant_ids should only contain one single element,
# while for tenant flow, tenant_ids can contain multiple elements.
"A String",
],
},
},
"name": "A String", # Required. The resource name of the IAP protected resource.
}
updateMask: string, The field mask specifying which IAP settings should be updated.
If omitted, the all of the settings are updated. See
https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The IAP configurable settings.
"applicationSettings": { # Wrapper over application specific settings for IAP. # Top level wrapper for all application related settings in IAP
"accessDeniedPageSettings": { # Custom content configuration for access denied page. # Customization for Access Denied page.
# IAP allows customers to define a custom URI to use as the error page when
# access is denied to users. If IAP prevents access to this page, the default
# IAP error page will be displayed instead.
"accessDeniedPageUri": "A String", # The URI to be redirected to when access is denied.
},
"csmSettings": { # Configuration for RCTokens generated for CSM workloads protected by IAP. # Settings to configure IAP's behavior for a CSM mesh.
# RCTokens are IAP generated JWTs that can be verified at the application. The
# RCToken is primarily used for ISTIO deployments, and can be scoped to a
# single mesh by configuring the audience field accordingly
"rctokenAud": "A String", # Audience claim set in the generated RCToken. This value is not validated by
# IAP.
},
},
"accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
"oauthSettings": { # Configuration for OAuth login&amp;consent flow behavior as well as for OAuth # Settings to configure IAP's OAuth behavior.
# Credentials.
"loginHint": "A String", # Domain hint to send as hd=? parameter in OAuth request flow. Enables
# redirect to primary IDP by skipping Google's login screen.
# https://developers.google.com/identity/protocols/OpenIDConnect#hd-param
# Note: IAP does not verify that the id token's hd claim matches this value
# since access behavior is managed by IAM policies.
"clientId": "A String", # OAuth 2.0 client ID used in the OAuth flow to generate an access token. If
# this field is set, you can skip obtaining the OAuth credentials in this
# step:
# https://developers.google.com/identity/protocols/OAuth2?hl=en_US#1.-obtain-oauth-2.0-credentials-from-the-google-api-console.
# However, this could allow for client sharing. The risks of client sharing
# are outlined here:
# https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.
},
"corsSettings": { # Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS # Configuration to allow cross-origin requests via IAP.
# call to bypass authentication and authorization.
"allowHttpOptions": True or False, # Configuration to allow HTTP OPTIONS calls to skip authorization. If
# undefined, IAP will not apply any special logic to OPTIONS requests.
},
"policyDelegationSettings": { # PolicyDelegationConfig allows google-internal teams to use IAP for apps # Settings to configure Policy delegation for apps hosted in tenant projects.
# INTERNAL_ONLY.
# hosted in a tenant project. Using these settings, the app can delegate
# permission check to happen against the linked customer project.
# This is only ever supposed to be used by google internal teams, hence the
# restriction on the proto.
"policyName": { # Policy name to be checked
"region": "A String", # For Cloud IAM:
# The location of the Policy.
# Must be empty or "global" for Policies owned by global IAM. Must name a
# region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see
# http://go/iam-faq#where-is-iam-currently-deployed.
#
# For Local IAM:
# This field should be set to "local".
"type": "A String", # Valid values for type might be 'gce', 'gcs', 'project', 'account' etc.
"id": "A String",
},
"iamPermission": "A String", # Permission to check in IAM.
"resource": { # IAM resource to check permission on
"labels": { # The service defined labels of the resource on which the conditions will be
# evaluated. The semantics - including the key names - are vague to IAM.
# If the effective condition has a reference to a `resource.labels[foo]`
# construct, IAM consults with this map to retrieve the values associated
# with `foo` key for Conditions evaluation. If the provided key is not found
# in the labels map, the condition would evaluate to false.
#
# This field is in limited use. If your intended use case is not expected
# to express resource.labels attribute in IAM Conditions, leave this field
# empty. Before planning on using this attribute please:
# * Read go/iam-conditions-labels-comm and ensure your service can meet the
# data availability and management requirements.
# * Talk to iam-conditions-eng@ about your use case.
"a_key": "A String",
},
"type": "A String", # The public resource type name of the resource on which conditions will be
# evaluated. It is configured using the official_name of the ResourceType as
# defined in service configurations under //configs/cloud/resourcetypes.
# For example, the official_name for GCP projects is set as
# 'cloudresourcemanager.googleapis.com/Project' according to
# //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml
# For details see go/iam-conditions-integration-guide.
"name": "A String", # Name of the resource on which conditions will be evaluated.
# Must use the Relative Resource Name of the resource, which is the URI
# path of the resource without the leading "/". Examples are
# "projects/_/buckets/[BUCKET-ID]" for storage buckets or
# "projects/[PROJECT-ID]/global/firewalls/[FIREWALL-ID]" for a firewall.
#
# This field is required for evaluating conditions with rules on resource
# names. For a `list` permission check, the resource.name value must be set
# to the parent resource. If the parent resource is a project, this field
# should be left unset.
"service": "A String", # The name of the service this resource belongs to. It is configured using
# the official_service_name of the Service as defined in service
# configurations under //configs/cloud/resourcetypes.
# For example, the official_service_name of cloud resource manager service
# is set as 'cloudresourcemanager.googleapis.com' according to
# //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml
},
"iamServiceName": "A String", # The DNS name of the service (e.g. "resourcemanager.googleapis.com").
# This should be the domain name part of the full resource names (see
# https://aip.dev/122#full-resource-names), which is usually
# the same as IamServiceSpec.service of the service where the resource type
# is defined.
},
"gcipSettings": { # Allows customers to configure tenant_id for GCIP instance per-app. # GCIP claims and endpoint configurations for 3p identity providers.
"loginPageUri": "A String", # Login page URI associated with the GCIP tenants.
# Typically, all resources within the same project share the same login page,
# though it could be overridden at the sub resource level.
"tenantIds": [ # GCIP tenant ids that are linked to the IAP resource.
# tenant_ids could be a string beginning with a number character to indicate
# authenticating with GCIP tenant flow, or in the format of _&lt;ProjectNumber&gt;
# to indicate authenticating with GCIP agent flow.
# If agent flow is used, tenant_ids should only contain one single element,
# while for tenant flow, tenant_ids can contain multiple elements.
"A String",
],
},
},
"name": "A String", # Required. The resource name of the IAP protected resource.
}</pre>
</div>
</body></html>