Method: updateIapSettings

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the updateMask is set.

HTTP request

PATCH https://iap.googleapis.com/v1/{iapSettings.name=**}:iapSettings

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
iapSettings.name

string

Required. The resource name of the IAP protected resource.

Query parameters

Parameters
updateMask

string (FieldMask format)

The field mask specifying which IAP settings should be updated. If omitted, then all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

Note: All IAP reauth settings must always be set together, using the field mask: iapSettings.accessSettings.reauthSettings.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of IapSettings.

Response body

If successful, the response body contains an instance of IapSettings.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires one of the following IAM permissions on the name resource, depending on the resource type:

  • iap.folders.updateSettings
  • iap.organizations.updateSettings
  • iap.projects.updateSettings
  • iap.web.updateSettings
  • iap.webServices.updateSettings
  • iap.webServiceVersions.updateSettings
  • iap.webTypes.updateSettings

For more information, see the IAM documentation.