Package google.cloud.iap.v1

Index

IdentityAwareProxyAdminService (interface)
IdentityAwareProxyOAuthService (interface)
AccessDeniedPageSettings (message)
AccessSettings (message)
AccessSettings.IdentitySource (enum)
AllowedDomainsSettings (message)
ApplicationSettings (message)
AttributePropagationSettings (message)
AttributePropagationSettings.OutputCredentials (enum)
Brand (message)
CorsSettings (message)
CreateBrandRequest (message)
CreateIdentityAwareProxyClientRequest (message)
CreateTunnelDestGroupRequest (message)
CsmSettings (message)
DeleteIdentityAwareProxyClientRequest (message)
DeleteTunnelDestGroupRequest (message)
GcipSettings (message)
GetBrandRequest (message)
GetIapSettingsRequest (message)
GetIdentityAwareProxyClientRequest (message)
GetTunnelDestGroupRequest (message)
IapSettings (message)
IdentityAwareProxyClient (message)
ListBrandsRequest (message)
ListBrandsResponse (message)
ListIdentityAwareProxyClientsRequest (message)
ListIdentityAwareProxyClientsResponse (message)
ListTunnelDestGroupsRequest (message)
ListTunnelDestGroupsResponse (message)
OAuth2 (message)
OAuthSettings (message)
ReauthSettings (message)
ReauthSettings.Method (enum)
ReauthSettings.PolicyType (enum)
ResetIdentityAwareProxyClientSecretRequest (message)
TunnelDestGroup (message)
UpdateIapSettingsRequest (message)
UpdateTunnelDestGroupRequest (message)
ValidateIapAttributeExpressionRequest (message)
ValidateIapAttributeExpressionResponse (message)
WorkforceIdentitySettings (message)

IdentityAwareProxyAdminService

APIs for Identity-Aware Proxy Admin configurations.

CreateTunnelDestGroup

rpc CreateTunnelDestGroup( CreateTunnelDestGroupRequest ) returns ( TunnelDestGroup )

Creates a new TunnelDestGroup.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the parent resource:

iap.tunnelDestGroups.create

For more information, see the IAM documentation .

DeleteTunnelDestGroup

rpc DeleteTunnelDestGroup( DeleteTunnelDestGroupRequest ) returns ( Empty )

Deletes a TunnelDestGroup.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

iap.tunnelDestGroups.delete

For more information, see the IAM documentation .

GetIamPolicy

rpc GetIamPolicy( GetIamPolicyRequest ) returns ( Policy )

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires one of the following IAM permissions on the resource resource, depending on the resource type:

iap.gateway.getIamPolicy
iap.tunnel.getIamPolicy
iap.tunnelDestGroups.getIamPolicy
iap.tunnelInstances.getIamPolicy
iap.tunnelLocations.getIamPolicy
iap.tunnelZones.getIamPolicy
iap.web.getIamPolicy
iap.webServices.getIamPolicy
iap.webServiceVersions.getIamPolicy
iap.webTypes.getIamPolicy

For more information, see the IAM documentation .

GetIapSettings

rpc GetIapSettings( GetIapSettingsRequest ) returns ( IapSettings )

Gets the IAP settings on a particular IAP protected resource.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires one of the following IAM permissions on the name resource, depending on the resource type:

iap.folders.getSettings
iap.organizations.getSettings
iap.projects.getSettings
iap.web.getSettings
iap.webServices.getSettings
iap.webServiceVersions.getSettings
iap.webTypes.getSettings

For more information, see the IAM documentation .

GetTunnelDestGroup

rpc GetTunnelDestGroup( GetTunnelDestGroupRequest ) returns ( TunnelDestGroup )

Retrieves an existing TunnelDestGroup.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

iap.tunnelDestGroups.get

For more information, see the IAM documentation .

ListTunnelDestGroups

rpc ListTunnelDestGroups( ListTunnelDestGroupsRequest ) returns ( ListTunnelDestGroupsResponse )

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the parent resource:

iap.tunnelDestGroups.list

For more information, see the IAM documentation .

SetIamPolicy

rpc SetIamPolicy( SetIamPolicyRequest ) returns ( Policy )

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires one of the following IAM permissions on the resource resource, depending on the resource type:

iap.gateway.setIamPolicy
iap.tunnel.setIamPolicy
iap.tunnelDestGroups.setIamPolicy
iap.tunnelInstances.setIamPolicy
iap.tunnelLocations.setIamPolicy
iap.tunnelZones.setIamPolicy
iap.web.setIamPolicy
iap.webServices.setIamPolicy
iap.webServiceVersions.setIamPolicy
iap.webTypes.setIamPolicy

For more information, see the IAM documentation .

TestIamPermissions

rpc TestIamPermissions( TestIamPermissionsRequest ) returns ( TestIamPermissionsResponse )

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

UpdateIapSettings

rpc UpdateIapSettings( UpdateIapSettingsRequest ) returns ( IapSettings )

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires one of the following IAM permissions on the name resource, depending on the resource type:

iap.folders.updateSettings
iap.organizations.updateSettings
iap.projects.updateSettings
iap.web.updateSettings
iap.webServices.updateSettings
iap.webServiceVersions.updateSettings
iap.webTypes.updateSettings

For more information, see the IAM documentation .

UpdateTunnelDestGroup

rpc UpdateTunnelDestGroup( UpdateTunnelDestGroupRequest ) returns ( TunnelDestGroup )

Updates a TunnelDestGroup.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

iap.tunnelDestGroups.update

For more information, see the IAM documentation .

ValidateIapAttributeExpression

rpc ValidateIapAttributeExpression( ValidateIapAttributeExpressionRequest ) returns ( ValidateIapAttributeExpressionResponse )

Validates that a given CEL expression conforms to IAP restrictions.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires one of the following IAM permissions on the name resource, depending on the resource type:

iap.folders.updateSettings
iap.organizations.updateSettings
iap.projects.updateSettings
iap.web.updateSettings
iap.webServices.updateSettings
iap.webServiceVersions.updateSettings
iap.webTypes.updateSettings

For more information, see the IAM documentation .

IdentityAwareProxyOAuthService

API to programmatically create, list and retrieve Identity Aware Proxy (IAP) OAuth brands; and create, retrieve, delete and reset-secret of IAP OAuth clients.

CreateBrand

rpc CreateBrand( CreateBrandRequest ) returns ( Brand )

Constructs a new OAuth brand for the project if one does not exist. The created brand is "internal only", meaning that OAuth clients created under it only accept requests from users who belong to the same Google Workspace organization as the project. The brand is created in an un-reviewed status. NOTE: The "internal only" status can be manually changed in the Google Cloud Console. Requires that a brand does not already exist for the project, and that the specified support email is owned by the caller.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

CreateIdentityAwareProxyClient

rpc CreateIdentityAwareProxyClient( CreateIdentityAwareProxyClientRequest ) returns ( IdentityAwareProxyClient )

Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

DeleteIdentityAwareProxyClient

rpc DeleteIdentityAwareProxyClient( DeleteIdentityAwareProxyClientRequest ) returns ( Empty )

Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

GetBrand

rpc GetBrand( GetBrandRequest ) returns ( Brand )

Retrieves the OAuth brand of the project.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

GetIdentityAwareProxyClient

rpc GetIdentityAwareProxyClient( GetIdentityAwareProxyClientRequest ) returns ( IdentityAwareProxyClient )

Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

ListBrands

rpc ListBrands( ListBrandsRequest ) returns ( ListBrandsResponse )

Lists the existing brands for the project.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

ListIdentityAwareProxyClients

rpc ListIdentityAwareProxyClients( ListIdentityAwareProxyClientsRequest ) returns ( ListIdentityAwareProxyClientsResponse )

Lists the existing clients for the brand.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

ResetIdentityAwareProxyClientSecret

rpc ResetIdentityAwareProxyClientSecret( ResetIdentityAwareProxyClientSecretRequest ) returns ( IdentityAwareProxyClient )

Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

AccessDeniedPageSettings

Custom content configuration 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.

Fields

Fields
`access_denied_page_uri`	`StringValue` The URI to be redirected to when access is denied.
`generate_troubleshooting_uri`	`BoolValue` Whether to generate a troubleshooting URL on access denied events to this application.
`remediation_token_generation_enabled`	`BoolValue` Whether to generate remediation token on access denied events to this application.

access_denied_page_uri

StringValue

The URI to be redirected to when access is denied.

generate_troubleshooting_uri

BoolValue

Whether to generate a troubleshooting URL on access denied events to this application.

remediation_token_generation_enabled

BoolValue

Whether to generate remediation token on access denied events to this application.

AccessSettings

Access related settings for IAP protected apps.

Fields
`gcip_settings`	`GcipSettings` Optional. GCIP claims and endpoint configurations for 3p identity providers.
`cors_settings`	`CorsSettings` Optional. Configuration to allow cross-origin requests via IAP.
`oauth_settings`	`OAuthSettings` Optional. Settings to configure IAP's OAuth behavior.
`reauth_settings`	`ReauthSettings` Optional. Settings to configure reauthentication policies in IAP.
`allowed_domains_settings`	`AllowedDomainsSettings` Optional. Settings to configure and enable allowed domains.
`workforce_identity_settings`	`WorkforceIdentitySettings` Optional. Settings to configure the workforce identity federation, including workforce pools and OAuth 2.0 settings.
`identity_sources[]`	`IdentitySource` Optional. Identity sources that IAP can use to authenticate the end user. Only one identity source can be configured.

IdentitySource

Types of identity source supported by IAP.

Enums
`IDENTITY_SOURCE_UNSPECIFIED`	IdentitySource Unspecified. When selected, IAP relies on which identity settings are fully configured to redirect the traffic to. The precedence order is WorkforceIdentitySettings > GcipSettings. If none is set, default to use Google identity.
`WORKFORCE_IDENTITY_FEDERATION`	Use external identities set up on Google Cloud Workforce Identity Federation.

AllowedDomainsSettings

Configuration for IAP allowed domains. Lets you to restrict access to an app and allow access to only the domains that you list.

Fields

Fields
`domains[]`	`string` Optional. List of trusted domains.
`enable`	`bool` Optional. Configuration for customers to opt in for the feature.

domains[]

string

Optional. List of trusted domains.

enable

bool

Optional. Configuration for customers to opt in for the feature.

ApplicationSettings

Wrapper over application specific settings for IAP.

Fields
`csm_settings`	`CsmSettings` Optional. Settings to configure IAP's behavior for a service mesh.
`access_denied_page_settings`	`AccessDeniedPageSettings` Optional. Customization for Access Denied page.
`cookie_domain`	`StringValue` 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.
`attribute_propagation_settings`	`AttributePropagationSettings` Optional. Settings to configure attribute propagation.

AttributePropagationSettings

Configuration for propagating attributes to applications protected by IAP.

Fields

output_credentials[]

OutputCredentials

Optional. Which output credentials attributes selected by the CEL expression should be propagated in. All attributes will be fully duplicated in each selected output credential.

expression

string

Optional. Raw string CEL expression. Must return a list of attributes. A maximum of 45 attributes can be selected. Expressions can select different attribute types from attributes : attributes.saml_attributes , attributes.iap_attributes . The following functions are supported:

filter <list>.filter(<iter_var>, <predicate>) : Returns a subset of <list> where <predicate> is true for every item.
in <var> in <list> : Returns true if <list> contains <var> .
selectByName <list>.selectByName(<string>) : Returns the attribute in <list> with the given <string> name, otherwise returns empty.
emitAs <attribute>.emitAs(<string>) : Sets the <attribute> name field to the given <string> for propagation in selected output credentials.
strict <attribute>.strict() : Ignores the x-goog-iap-attr- prefix for the provided <attribute> when propagating with the HEADER output credential, such as request headers.
append <target_list>.append(<attribute>) OR <target_list>.append(<list>) : Appends the provided <attribute> or <list> to the end of <target_list> .

Example expression: attributes.saml_attributes.filter(x, x.name in ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())

enable

bool

Optional. Whether the provided attribute propagation settings should be evaluated on user requests. If set to true, attributes returned from the expression will be propagated in the set output credentials.

OutputCredentials

Supported output credentials for attribute propagation. Each output credential maps to a "field" in the response. For example, selecting JWT will propagate all attributes in the IAP JWT, header in the headers, etc.

Enums
`OUTPUT_CREDENTIALS_UNSPECIFIED`	An output credential is required.
`HEADER`	Propagate attributes in the headers with "x-goog-iap-attr-" prefix.
`JWT`	Propagate attributes in the JWT of the form: `"additional_claims": { "my_attribute": ["value1", "value2"] }`
`RCTOKEN`	Propagate attributes in the RCToken of the form: `"additional_claims": { "my_attribute": ["value1", "value2"] }`

Brand

OAuth brand data. NOTE: Only contains a portion of the data that describes a brand.

Fields
`name`	`string` Output only. Identifier of the brand. NOTE: GCP project number achieves the same brand identification purpose as only one brand per project can be created.
`support_email`	`string` Support email displayed on the OAuth consent screen.
`application_title`	`string` Application name displayed on OAuth consent screen.
`org_internal_only`	`bool` Output only. Whether the brand is only intended for usage inside the G Suite organization only.

CorsSettings

Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization.

Fields

Fields
`allow_http_options`	`BoolValue` Configuration to allow HTTP `OPTIONS` calls to skip authentication and authorization. If undefined, IAP will not apply any special logic to `OPTIONS` requests.

allow_http_options

BoolValue

Configuration to allow HTTP OPTIONS calls to skip authentication and authorization. If undefined, IAP will not apply any special logic to OPTIONS requests.

CreateBrandRequest

The request sent to CreateBrand.

Fields

parent

string

Required. GCP Project number/id under which the brand is to be created. In the following format: projects/{project_number/id}.

Authorization requires the following IAM permission on the specified resource parent :

clientauthconfig.brands.create

brand

Brand

Required. The brand to be created.

CreateIdentityAwareProxyClientRequest

The request sent to CreateIdentityAwareProxyClient.

Fields

parent

string

Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a G Suite account.

Authorization requires one or more of the following IAM permissions on the specified resource parent :

clientauthconfig.brands.get
clientauthconfig.clients.create
clientauthconfig.clients.update

identity_aware_proxy_client

IdentityAwareProxyClient

Required. Identity Aware Proxy Client to be created.

CreateTunnelDestGroupRequest

The request to CreateTunnelDestGroup.

Fields

parent

string

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location} .

Authorization requires the following IAM permission on the specified resource parent :

iap.tunnelDestGroups.create

tunnel_dest_group

TunnelDestGroup

Required. The TunnelDestGroup to create.

tunnel_dest_group_id

string

Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name.

This value must be 4-63 characters, and valid characters are [a-z]- .

CsmSettings

Configuration for RCToken generated for service mesh workloads protected by IAP. RCToken are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for service mesh deployments, and can be scoped to a single mesh by configuring the audience field accordingly.

Fields

Fields
`rctoken_aud`	`StringValue` Audience claim set in the generated RCToken. This value is not validated by IAP.

rctoken_aud

StringValue

Audience claim set in the generated RCToken. This value is not validated by IAP.

DeleteIdentityAwareProxyClientRequest

The request sent to DeleteIdentityAwareProxyClient.

Fields

name

string

Required. Name of the Identity Aware Proxy client to be deleted. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}.

Authorization requires the following IAM permission on the specified resource name :

clientauthconfig.clients.delete

DeleteTunnelDestGroupRequest

The request to DeleteTunnelDestGroup.

Fields

name

string

Required. Name of the TunnelDestGroup to delete. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group} .

Authorization requires the following IAM permission on the specified resource name :

iap.tunnelDestGroups.delete

GcipSettings

Allows customers to configure tenant IDs for a Cloud Identity Platform (GCIP) instance for each application.

Fields

Fields
`tenant_ids[]`	`string` Optional. 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.
`login_page_uri`	`StringValue` 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.

tenant_ids[]

string

Optional. 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.

login_page_uri

StringValue

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.

GetBrandRequest

The request sent to GetBrand.

Fields

name

string

Required. Name of the brand to be fetched. In the following format: projects/{project_number/id}/brands/{brand}.

Authorization requires the following IAM permission on the specified resource name :

clientauthconfig.brands.get

GetIapSettingsRequest

The request sent to GetIapSettings.

Fields

name

string

Required. The resource name for which to retrieve the settings. Authorization: Requires the getSettings permission for the associated resource.

Authorization requires one or more of the following IAM permissions on the specified resource name :

iap.organizations.getSettings
iap.folders.getSettings
iap.projects.getSettings
iap.web.getSettings
iap.webTypes.getSettings
iap.webServices.getSettings
iap.webServiceVersions.getSettings

GetIdentityAwareProxyClientRequest

The request sent to GetIdentityAwareProxyClient.

Fields

name

string

Required. Name of the Identity Aware Proxy client to be fetched. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}.

Authorization requires the following IAM permission on the specified resource name :

clientauthconfig.clients.getWithSecret

GetTunnelDestGroupRequest

The request to GetTunnelDestGroup.

Fields

name

string

Required. Name of the TunnelDestGroup to be fetched. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group} .

Authorization requires the following IAM permission on the specified resource name :

iap.tunnelDestGroups.get

IapSettings

The IAP configurable settings.

Fields

Fields
`name`	`string` Required. The resource name of the IAP protected resource.
`access_settings`	`AccessSettings` Optional. Top level wrapper for all access related setting in IAP
`application_settings`	`ApplicationSettings` Optional. Top level wrapper for all application related settings in IAP

name

string

Required. The resource name of the IAP protected resource.

access_settings

AccessSettings

Optional. Top level wrapper for all access related setting in IAP

application_settings

ApplicationSettings

Optional. Top level wrapper for all application related settings in IAP

IdentityAwareProxyClient

Contains the data that describes an Identity Aware Proxy owned client.

Fields

Fields
`name`	`string` Output only. Unique identifier of the OAuth client.
`secret`	`string` Output only. Client secret of the OAuth client.
`display_name`	`string` Human-friendly name given to the OAuth client.

name

string

Output only. Unique identifier of the OAuth client.

secret

string

Output only. Client secret of the OAuth client.

display_name

string

Human-friendly name given to the OAuth client.

ListBrandsRequest

The request sent to ListBrands.

Fields

parent

string

Required. GCP Project number/id. In the following format: projects/{project_number/id}.

Authorization requires the following IAM permission on the specified resource parent :

clientauthconfig.brands.list

ListBrandsResponse

Response message for ListBrands.

Fields

Fields
`brands[]`	`Brand` Brands existing in the project.

brands[]

Brand

Brands existing in the project.

ListIdentityAwareProxyClientsRequest

The request sent to ListIdentityAwareProxyClients.

Fields

parent

string

Required. Full brand path. In the following format: projects/{project_number/id}/brands/{brand}.

Authorization requires the following IAM permission on the specified resource parent :

clientauthconfig.clients.listWithSecrets

page_size

int32

The maximum number of clients to return. The service may return fewer than this value. If unspecified, at most 100 clients will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_token

string

A page token, received from a previous ListIdentityAwareProxyClients call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListIdentityAwareProxyClients must match the call that provided the page token.

ListIdentityAwareProxyClientsResponse

Response message for ListIdentityAwareProxyClients.

Fields

Fields
`identity_aware_proxy_clients[]`	`IdentityAwareProxyClient` Clients existing in the brand.
`next_page_token`	`string` A token, which can be send as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

identity_aware_proxy_clients[]

IdentityAwareProxyClient

Clients existing in the brand.

next_page_token

string

A token, which can be send as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListTunnelDestGroupsRequest

The request to ListTunnelDestGroups.

Fields

parent

string

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location} . A - can be used for the location to group across all locations.

Authorization requires the following IAM permission on the specified resource parent :

iap.tunnelDestGroups.list

page_size

int32

The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 100 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

page_token

string

A page token, received from a previous ListTunnelDestGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTunnelDestGroups must match the call that provided the page token.

ListTunnelDestGroupsResponse

The response from ListTunnelDestGroups.

Fields

Fields
`tunnel_dest_groups[]`	`TunnelDestGroup` TunnelDestGroup existing in the project.
`next_page_token`	`string` A token that you can send as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

tunnel_dest_groups[]

TunnelDestGroup

TunnelDestGroup existing in the project.

next_page_token

string

A token that you can send as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

OAuth2

The OAuth 2.0 Settings

Fields

Fields
`client_id`	`string` The OAuth 2.0 client ID registered in the workforce identity federation OAuth 2.0 Server.
`client_secret`	`string` Input only. The OAuth 2.0 client secret created while registering the client ID.
`client_secret_sha256`	`string` Output only. SHA256 hash value for the client secret. This field is returned by IAP when the settings are retrieved.

client_id

string

The OAuth 2.0 client ID registered in the workforce identity federation OAuth 2.0 Server.

client_secret

string

Input only. The OAuth 2.0 client secret created while registering the client ID.

client_secret_sha256

string

Output only. SHA256 hash value for the client secret. This field is returned by IAP when the settings are retrieved.

OAuthSettings

Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.

Fields

Fields
`login_hint`	`StringValue` 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.
`programmatic_clients[]`	`string` Optional. List of client ids allowed to use IAP programmatically.

login_hint

StringValue

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.

programmatic_clients[]

string

Optional. List of client ids allowed to use IAP programmatically.

ReauthSettings

Configuration for IAP reauthentication policies.

Fields

Fields
`method`	`Method` Optional. Reauth method requested.
`max_age`	`Duration` Optional. Reauth session lifetime, how long before a user has to reauthenticate again.
`policy_type`	`PolicyType` Optional. How IAP determines the effective policy in cases of hierarchical policies. Policies are merged from higher in the hierarchy to lower in the hierarchy.

method

Method

Optional. Reauth method requested.

max_age

Duration

Optional. Reauth session lifetime, how long before a user has to reauthenticate again.

policy_type

PolicyType

Optional. How IAP determines the effective policy in cases of hierarchical policies. Policies are merged from higher in the hierarchy to lower in the hierarchy.

Method

Types of reauthentication methods supported by IAP.

Enums
`METHOD_UNSPECIFIED`	Reauthentication disabled.
`LOGIN`	Prompts the user to log in again.
`PASSWORD`	This item is deprecated!
`SECURE_KEY`	User must use their secure key 2nd factor device.
`ENROLLED_SECOND_FACTORS`	User can use any enabled 2nd factor.

PolicyType

Type of policy in the case of hierarchical policies.

Enums
`POLICY_TYPE_UNSPECIFIED`	Default value. This value is unused.
`MINIMUM`	This policy acts as a minimum to other policies, lower in the hierarchy. Effective policy may only be the same or stricter.
`DEFAULT`	This policy acts as a default if no other reauth policy is set.

ResetIdentityAwareProxyClientSecretRequest

The request sent to ResetIdentityAwareProxyClientSecret.

Fields

name

string

Required. Name of the Identity Aware Proxy client to that will have its secret reset. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}.

Authorization requires the following IAM permission on the specified resource name :

clientauthconfig.clients.update

TunnelDestGroup

A TunnelDestGroup.

Fields

Fields
`name`	`string` Identifier. Identifier for the TunnelDestGroup. Must be unique within the project and contain only lower case letters (a-z) and dashes (-).
`cidrs[]`	`string` Optional. Unordered list. List of CIDRs that this group applies to.
`fqdns[]`	`string` Optional. Unordered list. List of FQDNs that this group applies to.

name

string

Identifier. Identifier for the TunnelDestGroup. Must be unique within the project and contain only lower case letters (a-z) and dashes (-).

cidrs[]

string

Optional. Unordered list. List of CIDRs that this group applies to.

fqdns[]

string

Optional. Unordered list. List of FQDNs that this group applies to.

UpdateIapSettingsRequest

The request sent to UpdateIapSettings.

Fields

iap_settings

IapSettings

Required. The new values for the IAP settings to be updated. Authorization: Requires the updateSettings permission for the associated resource.

Authorization requires one or more of the following IAM permissions on the specified resource iapSettings :

iap.organizations.updateSettings
iap.folders.updateSettings
iap.projects.updateSettings
iap.web.updateSettings
iap.webTypes.updateSettings
iap.webServices.updateSettings
iap.webServiceVersions.updateSettings

update_mask

FieldMask

The field mask specifying which IAP settings should be updated. If omitted, then all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask .

Note: All IAP reauth settings must always be set together, using the field mask: iapSettings.accessSettings.reauthSettings .

UpdateTunnelDestGroupRequest

The request to UpdateTunnelDestGroup.

Fields

tunnel_dest_group

TunnelDestGroup

Required. The new values for the TunnelDestGroup.

Authorization requires the following IAM permission on the specified resource tunnelDestGroup :

iap.tunnelDestGroups.update

update_mask

FieldMask

A field mask that specifies which IAP settings to update. If omitted, then all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

ValidateIapAttributeExpressionRequest

Request sent to IAP Expression Linter endpoint.

Fields

Fields
`name`	`string` Required. The resource name of the IAP protected resource.
`expression`	`string` Required. User input string expression. Should be of the form `attributes.saml_attributes.filter(attribute, attribute.name in ['{attribute_name}', '{attribute_name}'])`

name

string

Required. The resource name of the IAP protected resource.

expression

string

Required. User input string expression. Should be of the form attributes.saml_attributes.filter(attribute, attribute.name in ['{attribute_name}', '{attribute_name}'])

ValidateIapAttributeExpressionResponse

This type has no fields.

IAP Expression Linter endpoint returns empty response body.

WorkforceIdentitySettings

WorkforceIdentitySettings allows customers to configure workforce pools and OAuth 2.0 settings to gate their applications using a third-party IdP with access control.

Fields

Fields
`workforce_pools[]`	`string` The workforce pool resources. Only one workforce pool is accepted.
`oauth2`	`OAuth2` OAuth 2.0 settings for IAP to perform OIDC flow with workforce identity federation services.

workforce_pools[]

string

The workforce pool resources. Only one workforce pool is accepted.

oauth2

OAuth2

OAuth 2.0 settings for IAP to perform OIDC flow with workforce identity federation services.

Package google.cloud.iap.v1 Stay organized with collections Save and categorize content based on your preferences.

Index

IdentityAwareProxyAdminService

IdentityAwareProxyOAuthService

AccessDeniedPageSettings

AccessSettings

IdentitySource

AllowedDomainsSettings

ApplicationSettings

AttributePropagationSettings

OutputCredentials

Brand

CorsSettings

CreateBrandRequest

CreateIdentityAwareProxyClientRequest

CreateTunnelDestGroupRequest

CsmSettings

DeleteIdentityAwareProxyClientRequest

DeleteTunnelDestGroupRequest

GcipSettings

GetBrandRequest

GetIapSettingsRequest

GetIdentityAwareProxyClientRequest

GetTunnelDestGroupRequest

IapSettings

IdentityAwareProxyClient

ListBrandsRequest

ListBrandsResponse

ListIdentityAwareProxyClientsRequest

ListIdentityAwareProxyClientsResponse

ListTunnelDestGroupsRequest

ListTunnelDestGroupsResponse

OAuth2

OAuthSettings

ReauthSettings

Method

PolicyType

ResetIdentityAwareProxyClientSecretRequest

TunnelDestGroup

UpdateIapSettingsRequest

UpdateTunnelDestGroupRequest

ValidateIapAttributeExpressionRequest

ValidateIapAttributeExpressionResponse

WorkforceIdentitySettings

Package google.cloud.iap.v1