Method: organizations.updateSettings

Updates the settings for the given resource. This method applies to all feature configurations for organization and folders.

v2.updateSettings fails when any of the following are true:

  • The value ofstorageLocation either isn't supported by Logging or violates the location OrgPolicy.
  • ThedefaultSinkConfig field is set, but it has an unspecified filter write mode.
  • The value ofkmsKeyName is invalid.
  • The associated service account doesn't have the requiredroles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.
  • Access to the key is disabled.

SeeConfigure default settings for organizations and folders for more information.

HTTP request

PATCH https://logging.googleapis.com/v2/{name=organizations/*}/settings

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name for the settings to update.

"organizations/[ORGANIZATION_ID]/settings""folders/[FOLDER_ID]/settings"

For example:

"organizations/12345/settings"

Authorization requires the followingIAM permission on the specified resourcename:

  • logging.settings.update

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Field mask identifying which fields fromsettings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.

SeeFieldMask for more information.

For example:"updateMask=kmsKeyName"

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

Request body

The request body contains an instance ofSettings.

Response body

If successful, the response body contains an instance ofSettings.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-21 UTC.