Documentation

Google_Service_CloudIAP_Resource_ProjectsBrandsIdentityAwareProxyClients extends Google_Service_Resource
in package

Application

The "identityAwareProxyClients" collection of methods.

Typical usage is: $iapService = new Google_Service_CloudIAP(...); $identityAwareProxyClients = $iapService->identityAwareProxyClients;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_CloudIAP_IdentityAwareProxyClient: Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use. (identityAwareProxyClients.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_CloudIAP_IapEmpty: 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.
get() : Google_Service_CloudIAP_IdentityAwareProxyClient: Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP. (identityAwareProxyClients.get)
listProjectsBrandsIdentityAwareProxyClients() : Google_Service_CloudIAP_ListIdentityAwareProxyClientsResponse: Lists the existing clients for the brand.
resetSecret() : Google_Service_CloudIAP_IdentityAwareProxyClient: Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

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. (identityAwareProxyClients.create)


    public
                create(string $parent, Google_Service_CloudIAP_IdentityAwareProxyClient $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIAP_IdentityAwareProxyClient

Parameters

$parent : string: Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a G Suite account.
$postBody : Google_Service_CloudIAP_IdentityAwareProxyClient
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIAP_IdentityAwareProxyClient —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

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.


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIAP_IapEmpty

(identityAwareProxyClients.delete)

Parameters

$name : string: Required. Name of the Identity Aware Proxy client to be deleted. In the following format: projects/{project_number/id}/brands/{brand} /identityAwareProxyClients/{client_id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIAP_IapEmpty —

get()

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


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIAP_IdentityAwareProxyClient

Parameters

$name : string: Required. Name of the Identity Aware Proxy client to be fetched. In the following format: projects/{project_number/id}/brands/{brand} /identityAwareProxyClients/{client_id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIAP_IdentityAwareProxyClient —

listProjectsBrandsIdentityAwareProxyClients()

Lists the existing clients for the brand.


    public
                listProjectsBrandsIdentityAwareProxyClients(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIAP_ListIdentityAwareProxyClientsResponse

(identityAwareProxyClients.listProjectsBrandsIdentityAwareProxyClients)

Parameters

$parent : string: Required. Full brand path. In the following format: projects/{project_number/id}/brands/{brand}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIAP_ListIdentityAwareProxyClientsResponse —

resetSecret()

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


    public
                resetSecret(string $name, Google_Service_CloudIAP_ResetIdentityAwareProxyClientSecretRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIAP_IdentityAwareProxyClient

(identityAwareProxyClients.resetSecret)

Parameters

$name : string: Required. Name of the Identity Aware Proxy client to that will have its secret reset. In the following format: projects/{project_number /id}/brands/{brand}/identityAwareProxyClients/{client_id}.
$postBody : Google_Service_CloudIAP_ResetIdentityAwareProxyClientSecretRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIAP_IdentityAwareProxyClient —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —