API documentation for iap_v1.types package.
Classes
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.
AccessSettings
Access related settings for IAP protected apps. .. attribute:: gcip_settings
GCIP claims and endpoint configurations for 3p identity providers.
ApplicationSettings
Wrapper over application specific settings for IAP. .. attribute:: csm_settings
Settings to configure IAP's behavior for a CSM mesh.
Brand
OAuth brand data. NOTE: Only contains a portion of the data that describes a brand.
CorsSettings
Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization.
CreateBrandRequest
The request sent to CreateBrand. .. attribute:: parent
Required. GCP Project number/id under which the brand is to be created. In the following format: projects/{project_number/id}.
:type: str
CreateIdentityAwareProxyClientRequest
The request sent to CreateIdentityAwareProxyClient. .. attribute:: parent
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.
:type: str
CsmSettings
Configuration for RCTokens generated for CSM workloads protected by IAP. 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
DeleteIdentityAwareProxyClientRequest
The request sent to DeleteIdentityAwareProxyClient. .. attribute:: name
Required. Name of the Identity Aware Proxy client to be deleted. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}.
:type: str
GcipSettings
Allows customers to configure tenant_id for GCIP instance per-app. .. attribute:: tenant_ids
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 _ 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.
:type: Sequence[str]
GetBrandRequest
The request sent to GetBrand. .. attribute:: name
Required. Name of the brand to be fetched. In the following format: projects/{project_number/id}/brands/{brand}.
:type: str
GetIapSettingsRequest
The request sent to GetIapSettings. .. attribute:: name
Required. The resource name for which to retrieve the
settings. Authorization: Requires the getSettings
permission for the associated resource.
:type: str
GetIdentityAwareProxyClientRequest
The request sent to GetIdentityAwareProxyClient. .. attribute:: name
Required. Name of the Identity Aware Proxy client to be fetched. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}.
:type: str
IapSettings
The IAP configurable settings. .. attribute:: name
Required. The resource name of the IAP protected resource.
:type: str
IdentityAwareProxyClient
Contains the data that describes an Identity Aware Proxy owned client.
ListBrandsRequest
The request sent to ListBrands. .. attribute:: parent
Required. GCP Project number/id. In the following format: projects/{project_number/id}.
:type: str
ListBrandsResponse
Response message for ListBrands. .. attribute:: brands
Brands existing in the project.
:type: Sequence[google.cloud.iap_v1.types.Brand]
ListIdentityAwareProxyClientsRequest
The request sent to ListIdentityAwareProxyClients. .. attribute:: parent
Required. Full brand path. In the following format: projects/{project_number/id}/brands/{brand}.
:type: str
ListIdentityAwareProxyClientsResponse
Response message for ListIdentityAwareProxyClients. .. attribute:: identity_aware_proxy_clients
Clients existing in the brand.
:type: Sequence[google.cloud.iap_v1.types.IdentityAwareProxyClient]
OAuthSettings
Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.
ResetIdentityAwareProxyClientSecretRequest
The request sent to ResetIdentityAwareProxyClientSecret. .. attribute:: name
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}.
:type: str
UpdateIapSettingsRequest
The request sent to UpdateIapSettings. .. attribute:: iap_settings
Required. The new values for the IAP settings to be updated.
Authorization: Requires the updateSettings permission
for the associated resource.