security_settings

Creates, updates, deletes, gets or lists a security_settings resource.

Overview

Name	security_settings
Type	Resource
Id	google.dialogflow.security_settings

Fields

The following fields are returned by SELECT queries:

projects_locations_security_settings_get

Successful response

Name	Datatype	Description
name	string	Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
audioExportSettings	object	Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent. (id: GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings)
deidentifyTemplate	string	DLP deidentify template name. Use this template to define de-identification configuration for the content. The DLP De-identify Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, Dialogflow replaces sensitive info with [redacted] text. The template name will have one of the following formats: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/ Note: deidentify_template must be located in the same region as the SecuritySettings.
displayName	string	Required. The human-readable name of the security settings, unique within the location.
insightsExportSettings	object	Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here. (id: GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings)
inspectTemplate	string	DLP inspect template name. Use this template to define inspect base settings. The DLP Inspect Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/ Note: inspect_template must be located in the same region as the SecuritySettings.
purgeDataTypes	array	List of types of data to remove when retention settings triggers purge.
redactionScope	string	Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
redactionStrategy	string	Strategy that defines how we do redaction.
retentionStrategy	string	Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
retentionWindowDays	integer (int32)	Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.

projects_locations_security_settings_list

Successful response

Name	Datatype	Description
name	string	Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
audioExportSettings	object	Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent. (id: GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings)
deidentifyTemplate	string	DLP deidentify template name. Use this template to define de-identification configuration for the content. The DLP De-identify Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, Dialogflow replaces sensitive info with [redacted] text. The template name will have one of the following formats: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/ Note: deidentify_template must be located in the same region as the SecuritySettings.
displayName	string	Required. The human-readable name of the security settings, unique within the location.
insightsExportSettings	object	Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here. (id: GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings)
inspectTemplate	string	DLP inspect template name. Use this template to define inspect base settings. The DLP Inspect Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/ Note: inspect_template must be located in the same region as the SecuritySettings.
purgeDataTypes	array	List of types of data to remove when retention settings triggers purge.
redactionScope	string	Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
redactionStrategy	string	Strategy that defines how we do redaction.
retentionStrategy	string	Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
retentionWindowDays	integer (int32)	Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_security_settings_get	select	projectsId, locationsId, securitySettingsId		Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
projects_locations_security_settings_list	select	projectsId, locationsId	pageSize, pageToken	Returns the list of all security settings in the specified location.
projects_locations_security_settings_create	insert	projectsId, locationsId		Create security settings in the specified location.
projects_locations_security_settings_patch	update	projectsId, locationsId, securitySettingsId	updateMask	Updates the specified SecuritySettings.
projects_locations_security_settings_delete	delete	projectsId, locationsId, securitySettingsId		Deletes the specified SecuritySettings.

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
locationsId	string
projectsId	string
securitySettingsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_security_settings_get

Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.

SELECT
name,
audioExportSettings,
deidentifyTemplate,
displayName,
insightsExportSettings,
inspectTemplate,
purgeDataTypes,
redactionScope,
redactionStrategy,
retentionStrategy,
retentionWindowDays
FROM google.dialogflow.security_settings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND securitySettingsId = '{{ securitySettingsId }}' -- required;

projects_locations_security_settings_list

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

SELECT
name,
audioExportSettings,
deidentifyTemplate,
displayName,
insightsExportSettings,
inspectTemplate,
purgeDataTypes,
redactionScope,
redactionStrategy,
retentionStrategy,
retentionWindowDays
FROM google.dialogflow.security_settings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_security_settings_create

Create security settings in the specified location.

INSERT INTO google.dialogflow.security_settings (
data__name,
data__displayName,
data__redactionStrategy,
data__redactionScope,
data__inspectTemplate,
data__deidentifyTemplate,
data__retentionWindowDays,
data__retentionStrategy,
data__purgeDataTypes,
data__audioExportSettings,
data__insightsExportSettings,
projectsId,
locationsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ redactionStrategy }}',
'{{ redactionScope }}',
'{{ inspectTemplate }}',
'{{ deidentifyTemplate }}',
{{ retentionWindowDays }},
'{{ retentionStrategy }}',
'{{ purgeDataTypes }}',
'{{ audioExportSettings }}',
'{{ insightsExportSettings }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
audioExportSettings,
deidentifyTemplate,
displayName,
insightsExportSettings,
inspectTemplate,
purgeDataTypes,
redactionScope,
redactionStrategy,
retentionStrategy,
retentionWindowDays
;

Manifest

# Description fields are for documentation purposes
- name: security_settings
  props:
    - name: projectsId
      value: string
      description: Required parameter for the security_settings resource.
    - name: locationsId
      value: string
      description: Required parameter for the security_settings resource.
    - name: name
      value: string
      description: >
        Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: `projects//locations//securitySettings/`.
        
    - name: displayName
      value: string
      description: >
        Required. The human-readable name of the security settings, unique within the location.
        
    - name: redactionStrategy
      value: string
      description: >
        Strategy that defines how we do redaction.
        
      valid_values: ['REDACTION_STRATEGY_UNSPECIFIED', 'REDACT_WITH_SERVICE']
    - name: redactionScope
      value: string
      description: >
        Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
        
      valid_values: ['REDACTION_SCOPE_UNSPECIFIED', 'REDACT_DISK_STORAGE']
    - name: inspectTemplate
      value: string
      description: >
        [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. The `DLP Inspect Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//locations//inspectTemplates/` OR `organizations//locations//inspectTemplates/` Note: `inspect_template` must be located in the same region as the `SecuritySettings`.
        
    - name: deidentifyTemplate
      value: string
      description: >
        [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. The `DLP De-identify Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, Dialogflow replaces sensitive info with `[redacted]` text. The template name will have one of the following formats: `projects//locations//deidentifyTemplates/` OR `organizations//locations//deidentifyTemplates/` Note: `deidentify_template` must be located in the same region as the `SecuritySettings`.
        
    - name: retentionWindowDays
      value: integer
      description: >
        Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.
        
    - name: retentionStrategy
      value: string
      description: >
        Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
        
      valid_values: ['RETENTION_STRATEGY_UNSPECIFIED', 'REMOVE_AFTER_CONVERSATION']
    - name: purgeDataTypes
      value: array
      description: >
        List of types of data to remove when retention settings triggers purge.
        
    - name: audioExportSettings
      value: object
      description: >
        Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent.
        
    - name: insightsExportSettings
      value: object
      description: >
        Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
        

UPDATE examples

projects_locations_security_settings_patch

Updates the specified SecuritySettings.

UPDATE google.dialogflow.security_settings
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__redactionStrategy = '{{ redactionStrategy }}',
data__redactionScope = '{{ redactionScope }}',
data__inspectTemplate = '{{ inspectTemplate }}',
data__deidentifyTemplate = '{{ deidentifyTemplate }}',
data__retentionWindowDays = {{ retentionWindowDays }},
data__retentionStrategy = '{{ retentionStrategy }}',
data__purgeDataTypes = '{{ purgeDataTypes }}',
data__audioExportSettings = '{{ audioExportSettings }}',
data__insightsExportSettings = '{{ insightsExportSettings }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND securitySettingsId = '{{ securitySettingsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
audioExportSettings,
deidentifyTemplate,
displayName,
insightsExportSettings,
inspectTemplate,
purgeDataTypes,
redactionScope,
redactionStrategy,
retentionStrategy,
retentionWindowDays;

DELETE examples

projects_locations_security_settings_delete

Deletes the specified SecuritySettings.

DELETE FROM google.dialogflow.security_settings
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND securitySettingsId = '{{ securitySettingsId }}' --required;