Skip to content

Commit 817c992

Browse files
committed
Updates from reviews
1 parent d1e4043 commit 817c992

File tree

5 files changed

+14
-39
lines changed

5 files changed

+14
-39
lines changed

docs/manage/users-roles/roles/construct-search-filter-for-role.md

Lines changed: 4 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,17 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
88
import RoleStacking from '../../../reuse/role-stacking-tip.md';
99

1010
This page describes how to define search filters for a role. These instructions apply to the **Search Filter** option in Step 6 of the [Create a role](/docs/manage/users-roles/roles/create-manage-roles/#create-a-role) procedure.
11-
12-
## Understanding search filters
13-
14-
A search filter for a role defines what log data a user with that role can access. You can define a search filter using keywords, wildcards, metadata fields, and logical operators. Here is a simple role filter:
15-
16-
```sql
17-
_sourceCategory=labs*
18-
```
19-
20-
This filter grants access to logs whose `_sourceCategory` begins with the string “labs”. (Logs whose `_sourceCategory` don’t start with “labs” won’t be accessible.)
21-
22-
When a user with this filter enters a query like:
23-
24-
```sql
25-
_sourceCategory=labs/apache | parse "* --" as src_ip | count by src_ip | sort _count
26-
```
27-
28-
Sumo Logic silently (it’s transparent to the user) adds the role filter to the beginning of the query with an `AND`:
29-
30-
```sql
31-
_sourceCategory=labs* AND (_sourceCategory=labs/apache | parse "* --" as src_ip | count by src_ip | sort _count)
32-
```
33-
34-
<!-- Hiding the following for work on DOCS-680
35-
The example above positively grants access to log data. You can do the opposite: explicitly deny access to data, with an exclamation point (!). For example:
36-
37-
```
38-
!_sourceCategory=JobX*
39-
```
40-
41-
The role filter above denies access to log data whose  `_sourceCategory` begins with “JobX”. (Access to log data with other source category values is not restricted.)
42-
-->
43-
44-
The examples above are simple: they involve a single role, and hence a single role filter. 
45-
46-
Typically however, a Sumo Logic user will have multiple roles. If a user has multiple roles, Sumo Logic `OR`s the several role filters and prepends that expression to the user’s queries with an `AND`, as discussed in [Multiple role filters and filter precedence](#multiple-role-filters-and-filter-precedence).
4711

4812
## Search filter basics
4913

50-
The sections below list search filter limitations, and describe how you can use keywords, wildcards, metadata, and logical operators in filters. 
14+
A search filter for a role defines what log data a user with that role can access. You can define a search filter using keywords, wildcards, metadata fields, and logical operators.
5115

52-
The explanations of the behavior of each example filter assume that no other role filters apply. In practice, you will likely assign multiple roles to users. After you understand the basics of how role filters work, see [Multiple role filters and filter precedence](#multiple-role-filters-and-filter-precedence).
16+
The explanations of the behavior of each example filter assume that no other role filters apply. In practice, you may assign multiple roles to users. After you understand the basics of how role filters work, see [Multiple role filters and filter precedence](#multiple-role-filters-and-filter-precedence).
5317

5418
### Search filter limitations
5519

20+
The sections below list search filter limitations, and describe how you can use keywords, wildcards, metadata, and logical operators in filters. 
21+
5622
* Role filters should include only keyword expressions or built-in metadata field expressions using these fields: `_sourcecategory`, `_collector`, `_source`, `_sourcename`, `_sourcehost`.
5723
* Using `_index` or `_view` in a role filter scope is not supported.
5824
* Role filters cannot include vertical pipes (`|`).

docs/manage/users-roles/roles/create-manage-roles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ However, if a user is assigned multiple roles that each have different Index Acc
7979

8080
## Test a role's log access rights
8181

82-
To test a role to see if it displays the expected log access behavior, select a role and click **Emulate log search**.
82+
To test a role to see if it displays the expected log access behavior, select a role and click **Emulate log search**. (You can also test a user. See [Test a user's log access rights](/docs/manage/users-roles/users/create-edit-users/#test-a-users-log-access-rights).)
8383

8484
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic/). In the main Sumo Logic menu select **Administration > Users and Roles > Roles**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui/). In the top menu select **Administration**, and then under **Users and Roles** select **Roles**. You can also click the **Go To...** menu at the top of the screen and select **Roles**.
8585
1. Select a role.

docs/manage/users-roles/users/create-edit-users.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,12 @@ When you add or remove a role from a user, it can take about an hour for the RBA
4646
1. Select the row for the user you want to edit and choose **Edit** from the three-dot kebab options menu.
4747
1. An edit pane appears on the right side of the page. For information about edit options, see [Create a user](#create-a-user) above.
4848
1. After editing the user, click **Save**.
49+
50+
## Test a user's log access rights
51+
52+
A user's permissions in Sumo Logic are determined by the [roles the user is assigned](/docs/manage/users-roles/roles/add-remove-users-role/). After assigning roles to a user, you can test the user to see if it displays the expected log access behavior based on its assigned roles. (You can also test a role. See [Test a role's log access rights](/docs/manage/users-roles/roles/create-manage-roles/#test-a-roles-log-access-rights).)
53+
54+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic/). In the main Sumo Logic menu select **Administration > Users and Roles > Users**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui/). In the top menu select **Administration**, and then under **Users and Roles** select **Users**. You can also click the **Go To...** menu at the top of the screen and select **Users**.
55+
1. Select a user.
56+
1. Click **More Actions > Emulate log search**. The search will be emulated for the permissions of the user.<br/><img src={useBaseUrl('img/users-roles/select-emulate-log-search.png')} alt="Emulate log search for a user" style={{border: '1px solid black'}} width="200"/>
57+
1. Enter your search parameters in the log search emulation window. The search will return only what is allowed for the user.<br/><img src={useBaseUrl('img/users-roles/emulate-log-search-as-user.png')} alt="Emulate log search window" style={{border: '1px solid black'}} width="800"/>
42 KB
Loading
35 KB
Loading

0 commit comments

Comments
 (0)