identity_aware_proxy_clients

Creates, updates, deletes, gets or lists an identity_aware_proxy_clients resource.

Overview

Name	identity_aware_proxy_clients
Type	Resource
Id	google.iap.identity_aware_proxy_clients

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Unique identifier of the OAuth client.
displayName	string	Human-friendly name given to the OAuth client.
secret	string	Output only. Client secret of the OAuth client.

list

Name	Datatype	Description
name	string	Output only. Unique identifier of the OAuth client.
displayName	string	Human-friendly name given to the OAuth client.
secret	string	Output only. Client secret of the OAuth client.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, brandsId, identityAwareProxyClientsId		Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP.
list	select	projectsId, brandsId	pageSize, pageToken	Lists the existing clients for the brand.
create	insert	projectsId, brandsId		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.
delete	delete	projectsId, brandsId, identityAwareProxyClientsId		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.
reset_secret	exec	projectsId, brandsId, identityAwareProxyClientsId		Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
brandsId	string
identityAwareProxyClientsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

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

SELECT
name,
displayName,
secret
FROM google.iap.identity_aware_proxy_clients
WHERE projectsId = '{{ projectsId }}' -- required
AND brandsId = '{{ brandsId }}' -- required
AND identityAwareProxyClientsId = '{{ identityAwareProxyClientsId }}' -- required
;

list

Lists the existing clients for the brand.

SELECT
name,
displayName,
secret
FROM google.iap.identity_aware_proxy_clients
WHERE projectsId = '{{ projectsId }}' -- required
AND brandsId = '{{ brandsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

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.

INSERT INTO google.iap.identity_aware_proxy_clients (
data__displayName,
projectsId,
brandsId
)
SELECT 
'{{ displayName }}',
'{{ projectsId }}',
'{{ brandsId }}'
RETURNING
name,
displayName,
secret
;

Manifest

# Description fields are for documentation purposes
- name: identity_aware_proxy_clients
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the identity_aware_proxy_clients resource.
  - name: brandsId
    value: "{{ brandsId }}"
    description: Required parameter for the identity_aware_proxy_clients resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Human-friendly name given to the OAuth client.

DELETE examples

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.

DELETE FROM google.iap.identity_aware_proxy_clients
WHERE projectsId = '{{ projectsId }}' --required
AND brandsId = '{{ brandsId }}' --required
AND identityAwareProxyClientsId = '{{ identityAwareProxyClientsId }}' --required
;

Lifecycle Methods

reset_secret

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

EXEC google.iap.identity_aware_proxy_clients.reset_secret 
@projectsId='{{ projectsId }}' --required, 
@brandsId='{{ brandsId }}' --required, 
@identityAwareProxyClientsId='{{ identityAwareProxyClientsId }}' --required
;