1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudIAP
  7. \
  8. Resource
  9. \
  10. ProjectsBrandsIdentityAwareProxyClients

ProjectsBrandsIdentityAwareProxyClients

class ProjectsBrandsIdentityAwareProxyClients extends Resource (View source)

The "identityAwareProxyClients" collection of methods.

Typical usage is:

 $iapService = new Google\Service\CloudIAP(...);
 $identityAwareProxyClients = $iapService->projects_brands_identityAwareProxyClients;

Methods

IdentityAwareProxyClient
create(string $parent, IdentityAwareProxyClient $postBody, array $optParams = [])

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)

IapEmpty
delete(string $name, array $optParams = [])

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.

IdentityAwareProxyClient
get(string $name, array $optParams = [])

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

ListIdentityAwareProxyClientsResponse
listProjectsBrandsIdentityAwareProxyClients(string $parent, array $optParams = [])

Lists the existing clients for the brand.

IdentityAwareProxyClient
resetSecret(string $name, ResetIdentityAwareProxyClientSecretRequest $postBody, array $optParams = [])

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

Details

at line 48
IdentityAwareProxyClient create(string $parent, IdentityAwareProxyClient $postBody, array $optParams = [])

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)

Parameters

string $parent

Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a G Suite account.
IdentityAwareProxyClient $postBody
array $optParams

Optional parameters.

Return Value

IdentityAwareProxyClient

Exceptions

Exception

at line 67
IapEmpty delete(string $name, array $optParams = [])

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.

(identityAwareProxyClients.delete)

Parameters

string $name

Required. Name of the Identity Aware Proxy client to be deleted. In the following format: projects/{project_number/id}/brands/{brand} /identityAwareProxyClients/{client_id}.
array $optParams

Optional parameters.

Return Value

IapEmpty

Exceptions

Exception

at line 84
IdentityAwareProxyClient get(string $name, array $optParams = [])

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

Parameters

string $name

Required. Name of the Identity Aware Proxy client to be fetched. In the following format: projects/{project_number/id}/brands/{brand} /identityAwareProxyClients/{client_id}.
array $optParams

Optional parameters.

Return Value

IdentityAwareProxyClient

Exceptions

Exception

at line 110
ListIdentityAwareProxyClientsResponse listProjectsBrandsIdentityAwareProxyClients(string $parent, array $optParams = [])

Lists the existing clients for the brand.

(identityAwareProxyClients.listProjectsBrandsIdentityAwareProxyClients)

Parameters

string $parent

Required. Full brand path. In the following format: projects/{project_number/id}/brands/{brand}.
array $optParams

Optional parameters.

Return Value

ListIdentityAwareProxyClientsResponse

Exceptions

Exception

at line 129
IdentityAwareProxyClient resetSecret(string $name, ResetIdentityAwareProxyClientSecretRequest $postBody, array $optParams = [])

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

(identityAwareProxyClients.resetSecret)

Parameters

string $name

Required. Name of the Identity Aware Proxy client to that will have its secret reset. In the following format: projects/{project_number /id}/brands/{brand}/identityAwareProxyClients/{client_id}.
ResetIdentityAwareProxyClientSecretRequest $postBody
array $optParams

Optional parameters.

Return Value

IdentityAwareProxyClient

Exceptions

Exception