REST Resource: projects.locations.securitySettings

Resource: SecuritySettings

Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.

JSON representation
{
  "name": string,
  "displayName": string,
  "redactionStrategy": enum (RedactionStrategy),
  "redactionScope": enum (RedactionScope),
  "inspectTemplate": string,
  "purgeDataTypes": [
    enum (PurgeDataType)
  ],
  "retentionWindowDays": integer
}
Fields
name

string

Required. Resource name of the settings. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

displayName

string

Required. The human-readable name of the security settings, unique within the location.

redactionStrategy

enum (RedactionStrategy)

Strategy that defines how we do redaction.

redactionScope

enum (RedactionScope)

Defines on what data we apply redaction. Note that we don't redact data to which we don't have access, e.g., Stackdriver logs.

inspectTemplate

string

DLP inspect template name. Use this template to define inspect base settings.

If empty, we use the default DLP inspect config.

The template name will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID

purgeDataTypes[]

enum (PurgeDataType)

List of types of data to remove when retention settings triggers purge.

retentionWindowDays

integer

Retains the data for the specified number of days. User must Set a value lower than Dialogflow's default 30d TTL. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use Dialogflow's default TTL.

RedactionStrategy

Defines how we redact data.

Enums
REDACTION_STRATEGY_UNSPECIFIED Do not redact.
REDACT_WITH_SERVICE Call redaction service to clean up the data to be persisted.

RedactionScope

Defines what types of data to redact.

Enums
REDACTION_SCOPE_UNSPECIFIED Don't redact any kind of data.
REDACT_DISK_STORAGE On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk.

PurgeDataType

Type of data we purge after retention settings triggers purge.

Enums
PURGE_DATA_TYPE_UNSPECIFIED Unspecified. Do not use.
DIALOGFLOW_HISTORY Dialogflow history. This does not include Stackdriver log, which is owned by the user not Dialogflow.

Methods

create

Create security settings in the specified location.

delete

Deletes the specified SecuritySettings.

get

Retrieves the specified SecuritySettings.

list

Returns the list of all security settings in the specified location.

patch

Updates the specified SecuritySettings.