Class IdentityAwareProxyOAuthServiceClient (1.5.4) 

IdentityAwareProxyOAuthServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.transports.base.IdentityAwareProxyOAuthServiceTransport]] = None, client_options: 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>)

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

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
IdentityAwareProxyOAuthServiceTransportThe transport used by the client instance.

Methods

IdentityAwareProxyOAuthServiceClient

IdentityAwareProxyOAuthServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.transports.base.IdentityAwareProxyOAuthServiceTransport]] = None, client_options: 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>)

Instantiates the identity aware proxy o auth service client.

Parameters
NameDescription
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 Union[str, IdentityAwareProxyOAuthServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_brand

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

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
NameDescription
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
TypeDescription
google.cloud.iap_v1.types.BrandOAuth brand data. NOTE: Only contains a portion of the data that describes a brand.

create_identity_aware_proxy_client

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

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
NameDescription
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
TypeDescription
google.cloud.iap_v1.types.IdentityAwareProxyClientContains the data that describes an Identity Aware Proxy owned client.

delete_identity_aware_proxy_client

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

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

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
IdentityAwareProxyOAuthServiceClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
IdentityAwareProxyOAuthServiceClientThe constructed client.

from_service_account_json

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

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
IdentityAwareProxyOAuthServiceClientThe constructed client.

get_brand

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

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
NameDescription
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
TypeDescription
google.cloud.iap_v1.types.BrandOAuth brand data. NOTE: Only contains a portion of the data that describes a brand.

get_identity_aware_proxy_client

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

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
NameDescription
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
TypeDescription
google.cloud.iap_v1.types.IdentityAwareProxyClientContains the data that describes an Identity Aware Proxy owned client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

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

Parameter
NameDescription
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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

list_brands

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

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
NameDescription
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
TypeDescription
google.cloud.iap_v1.types.ListBrandsResponseResponse message for ListBrands.

list_identity_aware_proxy_clients

list_identity_aware_proxy_clients(request: Optional[Union[google.cloud.iap_v1.types.service.ListIdentityAwareProxyClientsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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
NameDescription
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
TypeDescription
google.cloud.iap_v1.services.identity_aware_proxy_o_auth_service.pagers.ListIdentityAwareProxyClientsPagerResponse message for ListIdentityAwareProxyClients. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

reset_identity_aware_proxy_client_secret

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

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
NameDescription
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
TypeDescription
google.cloud.iap_v1.types.IdentityAwareProxyClientContains the data that describes an Identity Aware Proxy owned client.