Restricting Group Access to Data Using Row Security
As a Composer administrator, you can manually restrict the data in a data source configuration that can be viewed or used by an authorization group. By default, all data in a data source is available.
Row security filters allow you to secure potentially confidential data within a data source. Group members would only be able to view limited information within the data it collects.
Row security is supported by the API endpoint /api/sources/<source-id>/security/filters
. API documentation is provided with your Composer installation at this link: https://<composer-URL>/composer/swagger-ui.html
.
This section covers the following topics:
Adding Row Security Definitions
To add row security to restrict the data source data that can be viewed or used by a group:
Log into Composer as a Composer administrator.
If the user name you log in with is also associated with other Composer accounts, verify that the correct account is selected. See Switching Accounts.
Select Sources on the top-level navigation banner or in the UI menu (
). The Sources page appears.
Locate the data source for which you want to restrict data access and select
in the Row column for the data source. The Row Security dialog appears.
Select
. The Row Security dialog fills with information about the data source you selected.
Specify a name for the row security definition in the Name field. This name will be used to distinguish one row security field definition from another in the Row Security dialog.
Optionally, use the Description field to supply a description for the row security definition.
Use the drop-down list in the Group field to select a group to which the row security definition applies.
To add a restriction filter to the row security definition:
Select
. The Select a Field dialog appears.
Select a field for the restriction filter on the Select a Field dialog. A Select Values dialog appears with fields that vary, depending on the type of field you selected: attribute, number, or time.
Attribute Fields
If the field you selected is an attribute, the Select Values dialog allows you to:
Select the filter operator (Include or Exclude, depending on whether you want to include or exclude the value from the data).
Specify an optional custom value. To create and select a custom value, enter the value in the Customize field and select Add. Your custom field is added and selected in the list of possible values. To remove the custom value, uncheck it in the list of possible values. It is removed from the filter and from the list of possible values for the filter. You can insert variables as values for the attribute filter. See Inserting Variables for Row Security Restriction Filters.
Select one or more values from the list of available values for the attribute you selected. To select all values, select Select All.
Number Fields
If the field you select is a numeric field, the Select Values dialog allows you to:
Select a relational comparison operator in the Operator selection box. Data is included in the visual when the data in the filter field meets the condition set by the relational operator and the numeric values you specify. Valid numeric operators are described in Operators.
Use the arrows in the From and To boxes to increase and decrease the maximum and minimum values. You can insert variables as values for the numeric filter. See Inserting Variables for Row Security Restriction Filters.
Time Fields
If the field you select is a time field, the Select Values dialog allows you to use the From and To boxes to specify the time range for the filter. You can set the range in static time or dynamic time, or use preset ranges provided with Composer.
Select Static Time, Dynamic Time, or Variables in the fx drop-down menu.
If you select Variables, specify a variable to use for the time filter value. See Inserting Variables for Row Security Restriction Filters.
If you select Static Time, the From and To boxes are filled with default dates and times. Use the boxes to select specific from and to times.
If you select Dynamic Time, the From and To boxes are filled with Start of Data Set and End of Data Set automatically and a Condition dialog appears. Use the boxes on the Condition dialog to select different dynamic from and to times:
Alternatively, select
to fill the From and To boxes with predefined time ranges provided by Composer.
Use the filter box at the top of the presets list to locate the preset setting you want. Descriptions of each of the preset options are provided in Preset Time Ranges.
When your values are selected, select
. The Row Security dialog lists all restrictions specified for the row security definition.
To remove a restriction from the security definition, select
next to the restriction.
Repeat Step 8 if additional restrictions are needed. All restrictions for a row security definition are listed on the Row Security dialog.
When you are finished data restrictions for the group, select
to save the row security definition.
Repeat Steps 4-11 to add more row security definitions.
When all row security definition modifications have been made, select
to close the Row Security dialog.
Modifying Row Security Definitions
To modify a row security definition for a data source:
Log into Composer as a Composer administrator.
If the user name you log in with is also associated with other Composer accounts, verify that the correct account is selected. See Switching Accounts.
Select Sources on the top-level navigation banner or in the UI menu (
). The Sources page appears.
Locate the data source for which you want to restrict data access and select
in the Row column for the data source. The Row Security dialog appears.
To modify a row security definition, select it on the left side of the Row Security dialog. The settings for the definition appear in the Filter Details on the right side of the dialog and can be modified.
Modify any of the information for the row security definition, as described in Adding Row Security Definitions. When you are finished, select
to save the row security settings.
When all row security definition modifications have been made, select
to close the Row Security dialog.
Removing Row Security Definitions
To remove row security for a data source:
Log into Composer as a Composer administrator.
If the user name you log in with is also associated with other Composer accounts, verify that the correct account is selected. See Switching Accounts.
Select Sources on the top-level navigation banner or in the UI menu (
). The Sources page appears.
Locate the data source and select
in the Row column for the data source. The Row Security dialog appears.
Locate the row security definition you want to remove (delete) on the left side of the Row Security dialog and select
next to its name.
Select
on the confirmation dialog. The row security definition is removed.
When all row security definition modifications have been made, select
to close the Row Security dialog.
Comments
0 comments
Please sign in to leave a comment.