Security settings

Security settings are used to configure data redaction and data retention. For example, these settings control how data is redacted in Cloud logging and interaction logging used by Conversation history.

Security settings are set at the project level. If a user is granted access to an agent in a project, they can view project-level Security settings. To update project-level Security settings, a user should have the dialogflow.securitySettings. permission.

Note: For other redaction options, see parameter redaction.

The following table provides summary descriptions of the settings. For more information on the settings, see the RPC SecuritySettings reference.

Security settings	Description
redaction_strategy	Strategy used for redaction.
redaction_scope	The data redaction is applied to.
inspect_template	DLP inspect template name. There are no incremental costs when using DLP in Conversational Agents (Dialogflow CX).
deidentify_template	DLP deidentify template name. There are no incremental costs when using DLP in Conversational Agents (Dialogflow CX).
purge_data_types	Data to remove when a data retention purge is triggered.
retention_window_days	Number of days that data is retained.

Multiple security settings can be configured in each location. Each agent can specify the security settings to apply, and each setting can be applied to multiple agents in the same project and location. For more information about how data is applied at varying levels, see the data application levels.

If no security settings are specified in an agent, no redaction will be applied.

Create a security settings resource

To create a security settings resource in a particular location:

Console

1. Open the Dialogflow CX console.
2. Choose your Google Cloud project.
3. Select your agent.
4. Click Agent Settings.
5. Click the Security tab.
6. Click Manage Security Settings. The CCAI console opens in a new tab.
7. Click Create Security Settings in the CCAI console.
8. Enter security settings configuration.
9. Click Create.

API

See the create method for the SecuritySettings type. Go to the SecuritySettings API reference

Select a protocol and version for the SecuritySettings reference:

Protocol	V3	V3beta1
REST	SecuritySettings resource	SecuritySettings resource
RPC	SecuritySettings interface	SecuritySettings interface
C++	SecuritySettingssClient	Not available
C#	SecuritySettingssClient	Not available
Go	SecuritySettingssClient	Not available
Java	SecuritySettingssClient	SecuritySettingssClient
Node.js	SecuritySettingssClient	SecuritySettingssClient
PHP	Not available	Not available
Python	SecuritySettingssClient	SecuritySettingssClient
Ruby	Not available	Not available

Close

Specify a security setting in agent

To specify a security setting in agent:

Console

1. Open the Dialogflow CX console.
2. Choose your Google Cloud project.
3. Select your agent.
4. Click Agent Settings.
5. Click the Security tab.
6. Select the settings in Security settings drop down menu.
7. Click Save.

API

See the patch/update methods for the Agent type. Go to the Agent API reference

Select a protocol and version for the Agent reference:

Protocol	V3	V3beta1
REST	Agent resource	Agent resource
RPC	Agent interface	Agent interface
C++	AgentsClient	Not available
C#	AgentsClient	Not available
Go	AgentsClient	Not available
Java	AgentsClient	AgentsClient
Node.js	AgentsClient	AgentsClient
PHP	Not available	Not available
Python	AgentsClient	AgentsClient
Ruby	Not available	Not available

Close

Note: If the DLP inspect template is not defined, a default template is used. The default template only has some of the infoType detectors enabled and may be unreliable for identifying and removing the types as per the end-users requirement. Hence, it is recommended to always create a DLP template whenever possible.

Note: It may take hours for updates on these settings to propagate to all the related components and take effect.