docs: update generated docs (#981)
diff --git a/docs/dyn/iap_v1.v1.html b/docs/dyn/iap_v1.v1.html
index c1e5aca..af1f110 100644
--- a/docs/dyn/iap_v1.v1.html
+++ b/docs/dyn/iap_v1.v1.html
@@ -196,18 +196,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "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
@@ -236,6 +224,58 @@
# `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`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "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.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -283,60 +323,20 @@
],
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- #
- # If the condition evaluates to `true`, then this binding applies to the
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # 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.
- "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.
- "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.
- },
},
],
+ "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.
}</pre>
</div>
@@ -357,125 +357,125 @@
An object of the form:
{ # The IAP configurable settings.
- "accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
- "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth # Settings to configure IAP's OAuth behavior.
- # Credentials.
- "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.
- "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.
+ "name": "A String", # Required. The resource name of the IAP protected resource.
+ "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.
+ },
+ "cookieDomain": "A String", # The Domain value to set for cookies generated by IAP. This value is not
+ # validated by the API, but will be ignored at runtime if invalid.
+ },
+ "accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
+ "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.
+ "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.
+ "policyName": { # Policy name to be checked
+ "id": "A String",
+ "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
+ # 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.
},
- "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.
- },
- "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 _<ProjectNumber>
- # 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",
- ],
- },
- "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
- "type": "A String", # Valid values for type might be 'gce', 'gcs', 'project', 'account' etc.
- "id": "A String",
- "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
- # go/iam-faq#where-is-iam-currently-deployed.
- #
- # For Local IAM:
- # This field should be set to "local".
+ "iamPermission": "A String", # Permission to check in IAM.
+ "resource": { # IAM resource to check permission on
+ "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.
+ "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
+ "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.
+ "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",
},
- "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",
- },
- "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
- "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.
- "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.
- },
- "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.
- "iamPermission": "A String", # Permission to check in IAM.
},
},
- "name": "A String", # Required. The resource name of the IAP protected resource.
- "applicationSettings": { # Wrapper over application specific settings for IAP. # Top level wrapper for all application related settings in IAP
- "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.
- },
- "cookieDomain": "A String", # The Domain value to set for cookies generated by IAP. This value is not
- # validated by the API, but will be ignored at runtime if invalid.
- "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.
- },
+ "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 _<ProjectNumber>
+ # 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",
+ ],
},
- }</pre>
+ "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.
+ },
+ "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth # Settings to configure IAP's OAuth behavior.
+ # Credentials.
+ "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.
+ "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.
+ },
+ },
+ }</pre>
</div>
<div class="method">
@@ -562,18 +562,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "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
@@ -602,6 +590,58 @@
# `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`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "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.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -649,60 +689,20 @@
],
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- #
- # If the condition evaluates to `true`, then this binding applies to the
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # 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.
- "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.
- "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.
- },
},
],
+ "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.
},
}
@@ -781,18 +781,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "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
@@ -821,6 +809,58 @@
# `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`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "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.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -868,60 +908,20 @@
],
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- #
- # If the condition evaluates to `true`, then this binding applies to the
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # 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.
- "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.
- "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.
- },
},
],
+ "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.
}</pre>
</div>
@@ -974,48 +974,169 @@
The object takes the form of:
{ # The IAP configurable settings.
+ "name": "A String", # Required. The resource name of the IAP protected resource.
+ "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.
+ },
+ "cookieDomain": "A String", # The Domain value to set for cookies generated by IAP. This value is not
+ # validated by the API, but will be ignored at runtime if invalid.
+ },
+ "accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
+ "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.
+ "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.
+ "policyName": { # Policy name to be checked
+ "id": "A String",
+ "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
+ # 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.
+ },
+ "iamPermission": "A String", # Permission to check in IAM.
+ "resource": { # IAM resource to check permission on
+ "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.
+ "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
+ "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.
+ "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",
+ },
+ },
+ },
+ "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 _<ProjectNumber>
+ # 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",
+ ],
+ },
+ "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.
+ },
+ "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth # Settings to configure IAP's OAuth behavior.
+ # Credentials.
+ "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.
+ "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.
+ },
+ },
+}
+
+ 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.
+ "name": "A String", # Required. The resource name of the IAP protected resource.
+ "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.
+ },
+ "cookieDomain": "A String", # The Domain value to set for cookies generated by IAP. This value is not
+ # validated by the API, but will be ignored at runtime if invalid.
+ },
"accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
- "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth # Settings to configure IAP's OAuth behavior.
- # Credentials.
- "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.
- "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.
- },
- "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.
- },
- "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 _<ProjectNumber>
- # 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",
- ],
- },
"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.
+ "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.
"policyName": { # Policy name to be checked
- "type": "A String", # Valid values for type might be 'gce', 'gcs', 'project', 'account' etc.
"id": "A String",
"region": "A String", # For Cloud IAM:
# The location of the Policy.
@@ -1025,23 +1146,17 @@
#
# For Local IAM:
# This field should be set to "local".
+ "type": "A String", # Valid values for type might be 'gce', 'gcs', 'project', 'account' etc.
},
+ "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.
"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.
@@ -1058,173 +1173,58 @@
# 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.
- "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.
+ "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",
+ },
},
- "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.
- "iamPermission": "A String", # Permission to check in IAM.
+ },
+ "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 _<ProjectNumber>
+ # 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",
+ ],
+ },
+ "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.
+ },
+ "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth # Settings to configure IAP's OAuth behavior.
+ # Credentials.
+ "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.
+ "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.
},
},
- "name": "A String", # Required. The resource name of the IAP protected resource.
- "applicationSettings": { # Wrapper over application specific settings for IAP. # Top level wrapper for all application related settings in IAP
- "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.
- },
- "cookieDomain": "A String", # The Domain value to set for cookies generated by IAP. This value is not
- # validated by the API, but will be ignored at runtime if invalid.
- "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.
- },
- },
- }
-
- 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.
- "accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
- "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth # Settings to configure IAP's OAuth behavior.
- # Credentials.
- "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.
- "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.
- },
- "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.
- },
- "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 _<ProjectNumber>
- # 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",
- ],
- },
- "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
- "type": "A String", # Valid values for type might be 'gce', 'gcs', 'project', 'account' etc.
- "id": "A String",
- "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
- # go/iam-faq#where-is-iam-currently-deployed.
- #
- # For Local IAM:
- # This field should be set to "local".
- },
- "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",
- },
- "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
- "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.
- "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.
- },
- "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.
- "iamPermission": "A String", # Permission to check in IAM.
- },
- },
- "name": "A String", # Required. The resource name of the IAP protected resource.
- "applicationSettings": { # Wrapper over application specific settings for IAP. # Top level wrapper for all application related settings in IAP
- "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.
- },
- "cookieDomain": "A String", # The Domain value to set for cookies generated by IAP. This value is not
- # validated by the API, but will be ignored at runtime if invalid.
- "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.
- },
- },
- }</pre>
+ }</pre>
</div>
</body></html>
\ No newline at end of file