iap_settings
Creates, updates, deletes, gets or lists an iap_settings resource.
Overview
| Name | iap_settings |
| Type | Resource |
| Id | google.iap.iap_settings |
Fields
The following fields are returned by SELECT queries:
- get_iap_settings
Successful response
| Name | Datatype | Description |
|---|---|---|
name | string | Required. The resource name of the IAP protected resource. |
accessSettings | object | Optional. Top level wrapper for all access related setting in IAP (id: AccessSettings) |
applicationSettings | object | Optional. Top level wrapper for all application related settings in IAP (id: ApplicationSettings) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_iap_settings | select | v1Id | Gets the IAP settings on a particular IAP protected resource. | |
update_iap_settings | update | v1Id | updateMask | Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set. |
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 |
|---|---|---|
v1Id | string | |
updateMask | string (google-fieldmask) |
SELECT examples
- get_iap_settings
Gets the IAP settings on a particular IAP protected resource.
SELECT
name,
accessSettings,
applicationSettings
FROM google.iap.iap_settings
WHERE v1Id = '{{ v1Id }}' -- required;
UPDATE examples
- update_iap_settings
Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.
UPDATE google.iap.iap_settings
SET
data__name = '{{ name }}',
data__accessSettings = '{{ accessSettings }}',
data__applicationSettings = '{{ applicationSettings }}'
WHERE
v1Id = '{{ v1Id }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
accessSettings,
applicationSettings;