As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

IdentityAwareProxyOAuthService¶

class google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.IdentityAwareProxyOAuthServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.transports.base.IdentityAwareProxyOAuthServiceTransport, typing.Callable[[...], google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.transports.base.IdentityAwareProxyOAuthServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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

Instantiates the identity aware proxy o auth service async client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,IdentityAwareProxyOAuthServiceTransport,Callable[..., IdentityAwareProxyOAuthServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the IdentityAwareProxyOAuthServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_brand(request: Optional[Union[google.cloud.iap_v1.types.service.CreateBrandRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.Brand[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

async def sample_create_brand():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceAsyncClient()

    # Initialize request argument(s)
    request = iap_v1.CreateBrandRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_brand(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iap_v1.types.CreateBrandRequest, dict]]) – The request object. The request sent to CreateBrand.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.iap_v1.types.Brand

async create_identity_aware_proxy_client(request: Optional[Union[google.cloud.iap_v1.types.service.CreateIdentityAwareProxyClientRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.IdentityAwareProxyClient[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

async def sample_create_identity_aware_proxy_client():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceAsyncClient()

    # Initialize request argument(s)
    request = iap_v1.CreateIdentityAwareProxyClientRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_identity_aware_proxy_client(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iap_v1.types.CreateIdentityAwareProxyClientRequest, dict]]) – The request object. The request sent to CreateIdentityAwareProxyClient.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.iap_v1.types.IdentityAwareProxyClient

async delete_identity_aware_proxy_client(request: Optional[Union[google.cloud.iap_v1.types.service.DeleteIdentityAwareProxyClientRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

async def sample_delete_identity_aware_proxy_client():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceAsyncClient()

    # Initialize request argument(s)
    request = iap_v1.DeleteIdentityAwareProxyClientRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_identity_aware_proxy_client(request=request)

Parameters

request (Optional[Union[google.cloud.iap_v1.types.DeleteIdentityAwareProxyClientRequest, dict]]) – The request object. The request sent to DeleteIdentityAwareProxyClient.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IdentityAwareProxyOAuthServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IdentityAwareProxyOAuthServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IdentityAwareProxyOAuthServiceAsyncClient

async get_brand(request: Optional[Union[google.cloud.iap_v1.types.service.GetBrandRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.Brand[source]¶

Retrieves the OAuth brand of the project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

async def sample_get_brand():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceAsyncClient()

    # Initialize request argument(s)
    request = iap_v1.GetBrandRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_brand(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iap_v1.types.GetBrandRequest, dict]]) – The request object. The request sent to GetBrand.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.iap_v1.types.Brand

async get_identity_aware_proxy_client(request: Optional[Union[google.cloud.iap_v1.types.service.GetIdentityAwareProxyClientRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.IdentityAwareProxyClient[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

async def sample_get_identity_aware_proxy_client():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceAsyncClient()

    # Initialize request argument(s)
    request = iap_v1.GetIdentityAwareProxyClientRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_identity_aware_proxy_client(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iap_v1.types.GetIdentityAwareProxyClientRequest, dict]]) – The request object. The request sent to GetIdentityAwareProxyClient.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.iap_v1.types.IdentityAwareProxyClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.transports.base.IdentityAwareProxyOAuthServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_brands(request: Optional[Union[google.cloud.iap_v1.types.service.ListBrandsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.ListBrandsResponse[source]¶

Lists the existing brands for the project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

async def sample_list_brands():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceAsyncClient()

    # Initialize request argument(s)
    request = iap_v1.ListBrandsRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.list_brands(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iap_v1.types.ListBrandsRequest, dict]]) – The request object. The request sent to ListBrands.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListBrands.

Return type

google.cloud.iap_v1.types.ListBrandsResponse

async list_identity_aware_proxy_clients(request: Optional[Union[google.cloud.iap_v1.types.service.ListIdentityAwareProxyClientsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.pagers.ListIdentityAwareProxyClientsAsyncPager[source]¶

Lists the existing clients for the brand.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

async def sample_list_identity_aware_proxy_clients():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceAsyncClient()

    # Initialize request argument(s)
    request = iap_v1.ListIdentityAwareProxyClientsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_identity_aware_proxy_clients(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.iap_v1.types.ListIdentityAwareProxyClientsRequest, dict]]) – The request object. The request sent to ListIdentityAwareProxyClients.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListIdentityAwareProxyClients. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.pagers.ListIdentityAwareProxyClientsAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

async reset_identity_aware_proxy_client_secret(request: Optional[Union[google.cloud.iap_v1.types.service.ResetIdentityAwareProxyClientSecretRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.IdentityAwareProxyClient[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

async def sample_reset_identity_aware_proxy_client_secret():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceAsyncClient()

    # Initialize request argument(s)
    request = iap_v1.ResetIdentityAwareProxyClientSecretRequest(
        name="name_value",
    )

    # Make the request
    response = await client.reset_identity_aware_proxy_client_secret(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iap_v1.types.ResetIdentityAwareProxyClientSecretRequest, dict]]) – The request object. The request sent to ResetIdentityAwareProxyClientSecret.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.iap_v1.types.IdentityAwareProxyClient

property transport: google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.transports.base.IdentityAwareProxyOAuthServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: IdentityAwareProxyOAuthServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

class google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.IdentityAwareProxyOAuthServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.transports.base.IdentityAwareProxyOAuthServiceTransport, typing.Callable[[...], google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.transports.base.IdentityAwareProxyOAuthServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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

Instantiates the identity aware proxy o auth service client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,IdentityAwareProxyOAuthServiceTransport,Callable[..., IdentityAwareProxyOAuthServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the IdentityAwareProxyOAuthServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_brand(request: Optional[Union[google.cloud.iap_v1.types.service.CreateBrandRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.Brand[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

def sample_create_brand():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceClient()

    # Initialize request argument(s)
    request = iap_v1.CreateBrandRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_brand(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iap_v1.types.CreateBrandRequest, dict]) – The request object. The request sent to CreateBrand.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.iap_v1.types.Brand

create_identity_aware_proxy_client(request: Optional[Union[google.cloud.iap_v1.types.service.CreateIdentityAwareProxyClientRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.IdentityAwareProxyClient[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

def sample_create_identity_aware_proxy_client():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceClient()

    # Initialize request argument(s)
    request = iap_v1.CreateIdentityAwareProxyClientRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_identity_aware_proxy_client(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iap_v1.types.CreateIdentityAwareProxyClientRequest, dict]) – The request object. The request sent to CreateIdentityAwareProxyClient.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.iap_v1.types.IdentityAwareProxyClient

delete_identity_aware_proxy_client(request: Optional[Union[google.cloud.iap_v1.types.service.DeleteIdentityAwareProxyClientRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

def sample_delete_identity_aware_proxy_client():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceClient()

    # Initialize request argument(s)
    request = iap_v1.DeleteIdentityAwareProxyClientRequest(
        name="name_value",
    )

    # Make the request
    client.delete_identity_aware_proxy_client(request=request)

Parameters

request (Union[google.cloud.iap_v1.types.DeleteIdentityAwareProxyClientRequest, dict]) – The request object. The request sent to DeleteIdentityAwareProxyClient.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IdentityAwareProxyOAuthServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IdentityAwareProxyOAuthServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IdentityAwareProxyOAuthServiceClient

get_brand(request: Optional[Union[google.cloud.iap_v1.types.service.GetBrandRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.Brand[source]¶

Retrieves the OAuth brand of the project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

def sample_get_brand():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceClient()

    # Initialize request argument(s)
    request = iap_v1.GetBrandRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_brand(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iap_v1.types.GetBrandRequest, dict]) – The request object. The request sent to GetBrand.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.iap_v1.types.Brand

get_identity_aware_proxy_client(request: Optional[Union[google.cloud.iap_v1.types.service.GetIdentityAwareProxyClientRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.IdentityAwareProxyClient[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

def sample_get_identity_aware_proxy_client():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceClient()

    # Initialize request argument(s)
    request = iap_v1.GetIdentityAwareProxyClientRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_identity_aware_proxy_client(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iap_v1.types.GetIdentityAwareProxyClientRequest, dict]) – The request object. The request sent to GetIdentityAwareProxyClient.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.iap_v1.types.IdentityAwareProxyClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

list_brands(request: Optional[Union[google.cloud.iap_v1.types.service.ListBrandsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.ListBrandsResponse[source]¶

Lists the existing brands for the project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

def sample_list_brands():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceClient()

    # Initialize request argument(s)
    request = iap_v1.ListBrandsRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.list_brands(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iap_v1.types.ListBrandsRequest, dict]) – The request object. The request sent to ListBrands.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListBrands.

Return type

google.cloud.iap_v1.types.ListBrandsResponse

list_identity_aware_proxy_clients(request: Optional[Union[google.cloud.iap_v1.types.service.ListIdentityAwareProxyClientsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.pagers.ListIdentityAwareProxyClientsPager[source]¶

Lists the existing clients for the brand.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

def sample_list_identity_aware_proxy_clients():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceClient()

    # Initialize request argument(s)
    request = iap_v1.ListIdentityAwareProxyClientsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_identity_aware_proxy_clients(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.iap_v1.types.ListIdentityAwareProxyClientsRequest, dict]) – The request object. The request sent to ListIdentityAwareProxyClients.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListIdentityAwareProxyClients. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.pagers.ListIdentityAwareProxyClientsPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

reset_identity_aware_proxy_client_secret(request: Optional[Union[google.cloud.iap_v1.types.service.ResetIdentityAwareProxyClientSecretRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iap_v1.types.service.IdentityAwareProxyClient[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iap_v1

def sample_reset_identity_aware_proxy_client_secret():
    # Create a client
    client = iap_v1.IdentityAwareProxyOAuthServiceClient()

    # Initialize request argument(s)
    request = iap_v1.ResetIdentityAwareProxyClientSecretRequest(
        name="name_value",
    )

    # Make the request
    response = client.reset_identity_aware_proxy_client_secret(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iap_v1.types.ResetIdentityAwareProxyClientSecretRequest, dict]) – The request object. The request sent to ResetIdentityAwareProxyClientSecret.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.iap_v1.types.IdentityAwareProxyClient

property transport: google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.transports.base.IdentityAwareProxyOAuthServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

IdentityAwareProxyOAuthServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

class google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.pagers.ListIdentityAwareProxyClientsAsyncPager(method: Callable[[...], Awaitable[google.cloud.iap_v1.types.service.ListIdentityAwareProxyClientsResponse]], request: google.cloud.iap_v1.types.service.ListIdentityAwareProxyClientsRequest, response: google.cloud.iap_v1.types.service.ListIdentityAwareProxyClientsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_identity_aware_proxy_clients requests.

This class thinly wraps an initial google.cloud.iap_v1.types.ListIdentityAwareProxyClientsResponse object, and provides an __aiter__ method to iterate through its identity_aware_proxy_clients field.

If there are more pages, the __aiter__ method will make additional ListIdentityAwareProxyClients requests and continue to iterate through the identity_aware_proxy_clients field on the corresponding responses.

All the usual google.cloud.iap_v1.types.ListIdentityAwareProxyClientsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.iap_v1.types.ListIdentityAwareProxyClientsRequest) – The initial request object.
response (google.cloud.iap_v1.types.ListIdentityAwareProxyClientsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.pagers.ListIdentityAwareProxyClientsPager(method: Callable[[...], google.cloud.iap_v1.types.service.ListIdentityAwareProxyClientsResponse], request: google.cloud.iap_v1.types.service.ListIdentityAwareProxyClientsRequest, response: google.cloud.iap_v1.types.service.ListIdentityAwareProxyClientsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_identity_aware_proxy_clients requests.

This class thinly wraps an initial google.cloud.iap_v1.types.ListIdentityAwareProxyClientsResponse object, and provides an __iter__ method to iterate through its identity_aware_proxy_clients field.

If there are more pages, the __iter__ method will make additional ListIdentityAwareProxyClients requests and continue to iterate through the identity_aware_proxy_clients field on the corresponding responses.

All the usual google.cloud.iap_v1.types.ListIdentityAwareProxyClientsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.iap_v1.types.ListIdentityAwareProxyClientsRequest) – The initial request object.
response (google.cloud.iap_v1.types.ListIdentityAwareProxyClientsResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

IdentityAwareProxyOAuthService¶

google-cloud-iap

Navigation

Related Topics