Google Cloud Iap V1 Client - Class IdentityAwareProxyOAuthServiceClient (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Iap V1 Client class IdentityAwareProxyOAuthServiceClient.

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Namespace

Google \ Cloud \ Iap \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array

Optional. Options for configuring the service API wrapper.
↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "
↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createBrand

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.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient::createBrandAsync() .

Parameters
Name Description
request Google\Cloud\Iap\V1\CreateBrandRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\Iap\V1\Brand
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\Brand;
use Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient;
use Google\Cloud\Iap\V1\CreateBrandRequest;

/**
 * @param string $parent GCP Project number/id under which the brand is to be created.
 *                       In the following format: projects/{project_number/id}.
 */
function create_brand_sample(string $parent): void
{
    // Create a client.
    $identityAwareProxyOAuthServiceClient = new IdentityAwareProxyOAuthServiceClient();

    // Prepare the request message.
    $brand = new Brand();
    $request = (new CreateBrandRequest())
        ->setParent($parent)
        ->setBrand($brand);

    // Call the API and handle any network failures.
    try {
        /** @var Brand $response */
        $response = $identityAwareProxyOAuthServiceClient->createBrand($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $parent = '[PARENT]';

    create_brand_sample($parent);
}

createIdentityAwareProxyClient

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.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient::createIdentityAwareProxyClientAsync() .

Parameters
Name Description
request Google\Cloud\Iap\V1\CreateIdentityAwareProxyClientRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\Iap\V1\IdentityAwareProxyClient
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient;
use Google\Cloud\Iap\V1\CreateIdentityAwareProxyClientRequest;
use Google\Cloud\Iap\V1\IdentityAwareProxyClient;

/**
 * @param string $parent 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.
 */
function create_identity_aware_proxy_client_sample(string $parent): void
{
    // Create a client.
    $identityAwareProxyOAuthServiceClient = new IdentityAwareProxyOAuthServiceClient();

    // Prepare the request message.
    $identityAwareProxyClient = new IdentityAwareProxyClient();
    $request = (new CreateIdentityAwareProxyClientRequest())
        ->setParent($parent)
        ->setIdentityAwareProxyClient($identityAwareProxyClient);

    // Call the API and handle any network failures.
    try {
        /** @var IdentityAwareProxyClient $response */
        $response = $identityAwareProxyOAuthServiceClient->createIdentityAwareProxyClient($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $parent = '[PARENT]';

    create_identity_aware_proxy_client_sample($parent);
}

deleteIdentityAwareProxyClient

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.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient::deleteIdentityAwareProxyClientAsync() .

Parameters
Name Description
request Google\Cloud\Iap\V1\DeleteIdentityAwareProxyClientRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient;
use Google\Cloud\Iap\V1\DeleteIdentityAwareProxyClientRequest;

/**
 * @param string $name Name of the Identity Aware Proxy client to be deleted.
 *                     In the following format:
 *                     projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}.
 */
function delete_identity_aware_proxy_client_sample(string $name): void
{
    // Create a client.
    $identityAwareProxyOAuthServiceClient = new IdentityAwareProxyOAuthServiceClient();

    // Prepare the request message.
    $request = (new DeleteIdentityAwareProxyClientRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        $identityAwareProxyOAuthServiceClient->deleteIdentityAwareProxyClient($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $name = '[NAME]';

    delete_identity_aware_proxy_client_sample($name);
}

getBrand

Retrieves the OAuth brand of the project.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient::getBrandAsync() .

Parameters
Name Description
request Google\Cloud\Iap\V1\GetBrandRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\Iap\V1\Brand
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\Brand;
use Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient;
use Google\Cloud\Iap\V1\GetBrandRequest;

/**
 * @param string $name Name of the brand to be fetched.
 *                     In the following format: projects/{project_number/id}/brands/{brand}.
 */
function get_brand_sample(string $name): void
{
    // Create a client.
    $identityAwareProxyOAuthServiceClient = new IdentityAwareProxyOAuthServiceClient();

    // Prepare the request message.
    $request = (new GetBrandRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var Brand $response */
        $response = $identityAwareProxyOAuthServiceClient->getBrand($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $name = '[NAME]';

    get_brand_sample($name);
}

getIdentityAwareProxyClient

Retrieves an Identity Aware Proxy (IAP) OAuth client.

Requires that the client is owned by IAP.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient::getIdentityAwareProxyClientAsync() .

Parameters
Name Description
request Google\Cloud\Iap\V1\GetIdentityAwareProxyClientRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\Iap\V1\IdentityAwareProxyClient
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient;
use Google\Cloud\Iap\V1\GetIdentityAwareProxyClientRequest;
use Google\Cloud\Iap\V1\IdentityAwareProxyClient;

/**
 * @param string $name Name of the Identity Aware Proxy client to be fetched.
 *                     In the following format:
 *                     projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}.
 */
function get_identity_aware_proxy_client_sample(string $name): void
{
    // Create a client.
    $identityAwareProxyOAuthServiceClient = new IdentityAwareProxyOAuthServiceClient();

    // Prepare the request message.
    $request = (new GetIdentityAwareProxyClientRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var IdentityAwareProxyClient $response */
        $response = $identityAwareProxyOAuthServiceClient->getIdentityAwareProxyClient($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $name = '[NAME]';

    get_identity_aware_proxy_client_sample($name);
}

listBrands

Lists the existing brands for the project.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient::listBrandsAsync() .

Parameters
Name Description
request Google\Cloud\Iap\V1\ListBrandsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\Iap\V1\ListBrandsResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient;
use Google\Cloud\Iap\V1\ListBrandsRequest;
use Google\Cloud\Iap\V1\ListBrandsResponse;

/**
 * @param string $parent GCP Project number/id.
 *                       In the following format: projects/{project_number/id}.
 */
function list_brands_sample(string $parent): void
{
    // Create a client.
    $identityAwareProxyOAuthServiceClient = new IdentityAwareProxyOAuthServiceClient();

    // Prepare the request message.
    $request = (new ListBrandsRequest())
        ->setParent($parent);

    // Call the API and handle any network failures.
    try {
        /** @var ListBrandsResponse $response */
        $response = $identityAwareProxyOAuthServiceClient->listBrands($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $parent = '[PARENT]';

    list_brands_sample($parent);
}

listIdentityAwareProxyClients

Lists the existing clients for the brand.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient::listIdentityAwareProxyClientsAsync() .

Parameters
Name Description
request Google\Cloud\Iap\V1\ListIdentityAwareProxyClientsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient;
use Google\Cloud\Iap\V1\IdentityAwareProxyClient;
use Google\Cloud\Iap\V1\ListIdentityAwareProxyClientsRequest;

/**
 * @param string $parent Full brand path.
 *                       In the following format: projects/{project_number/id}/brands/{brand}.
 */
function list_identity_aware_proxy_clients_sample(string $parent): void
{
    // Create a client.
    $identityAwareProxyOAuthServiceClient = new IdentityAwareProxyOAuthServiceClient();

    // Prepare the request message.
    $request = (new ListIdentityAwareProxyClientsRequest())
        ->setParent($parent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $identityAwareProxyOAuthServiceClient->listIdentityAwareProxyClients($request);

        /** @var IdentityAwareProxyClient $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $parent = '[PARENT]';

    list_identity_aware_proxy_clients_sample($parent);
}

resetIdentityAwareProxyClientSecret

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

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient::resetIdentityAwareProxyClientSecretAsync() .

Parameters
Name Description
request Google\Cloud\Iap\V1\ResetIdentityAwareProxyClientSecretRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\Iap\V1\IdentityAwareProxyClient
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\Client\IdentityAwareProxyOAuthServiceClient;
use Google\Cloud\Iap\V1\IdentityAwareProxyClient;
use Google\Cloud\Iap\V1\ResetIdentityAwareProxyClientSecretRequest;

/**
 * @param string $name 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}.
 */
function reset_identity_aware_proxy_client_secret_sample(string $name): void
{
    // Create a client.
    $identityAwareProxyOAuthServiceClient = new IdentityAwareProxyOAuthServiceClient();

    // Prepare the request message.
    $request = (new ResetIdentityAwareProxyClientSecretRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var IdentityAwareProxyClient $response */
        $response = $identityAwareProxyOAuthServiceClient->resetIdentityAwareProxyClientSecret($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $name = '[NAME]';

    reset_identity_aware_proxy_client_secret_sample($name);
}

createBrandAsync

Parameters
Name Description
request Google\Cloud\Iap\V1\CreateBrandRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

createIdentityAwareProxyClientAsync

Parameters
Name Description
request Google\Cloud\Iap\V1\CreateIdentityAwareProxyClientRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

deleteIdentityAwareProxyClientAsync

Parameters
Name Description
request Google\Cloud\Iap\V1\DeleteIdentityAwareProxyClientRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getBrandAsync

Parameters
Name Description
request Google\Cloud\Iap\V1\GetBrandRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getIdentityAwareProxyClientAsync

Parameters
Name Description
request Google\Cloud\Iap\V1\GetIdentityAwareProxyClientRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listBrandsAsync

Parameters
Name Description
request Google\Cloud\Iap\V1\ListBrandsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listIdentityAwareProxyClientsAsync

Parameters
Name Description
request Google\Cloud\Iap\V1\ListIdentityAwareProxyClientsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

resetIdentityAwareProxyClientSecretAsync

Parameters
Name Description
request Google\Cloud\Iap\V1\ResetIdentityAwareProxyClientSecretRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface