Skip to content

Commit a2305f7

Browse files
committed
rbac for deep search
1 parent 096eb89 commit a2305f7

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Access control for Deep Search
2+
3+
Granular controls for who can access [Deep Search](/deepsearch/) can be configured by site admins by tuning the roles assigned to users and the permissions granted to those roles. This page describes the permission types available for Deep Search, and whether they are granted by default to the **User** [system role](/admin/access_control#system-roles). All permissions are granted to the **Site Administrator** system role by default.
4+
5+
Name | Description | Granted to **User** by default?
6+
--------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----------------------------:
7+
`deep_search:read` | <ul><li>User can see the Deep Search menu item in the top-level menu bar.</li><li>User can read their own threads and threads that are shared with them.</li></ul> | ✓
8+
`deep_search:write` | User can create or update a Deep Search. | ✓

docs/admin/access_control/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
<Callout type="note">This page refers to in-product permissions, which determine who can, for example, create a batch change, or who is a site admin. This is *not* the same as [repository permissions](/admin/permissions/), which enforces the same repository access on Sourcegraph as your code host.</Callout>
1313

14-
Sourcegraph uses [Role-Based Access Control (RBAC)](https://en.wikipedia.org/wiki/Role-based_access_control) to enable fine-grained control over different features and abilities of Sourcegraph, without having to modify permissions for each user individually. Currently, the scope of permissions control is limited to [Batch Changes](/admin/access_control/batch_changes) functionality, but it will be expanded to other areas in the future.
14+
Sourcegraph uses [Role-Based Access Control (RBAC)](https://en.wikipedia.org/wiki/Role-based_access_control) to enable fine-grained control over different features and abilities of Sourcegraph, without having to modify permissions for each user individually.
1515

1616
## Managing roles and permissions
1717

@@ -39,6 +39,7 @@ To edit the permissions granted to a role, click the role to expand it, then sel
3939
You can read about the specific permission types available for each RBAC-enabled product area below:
4040

4141
- [Batch Changes](/admin/access_control/batch_changes)
42+
- [Deep Search](/admin/access_control/deep_search)
4243
- [Ownership](/admin/access_control/ownership)
4344
- [Service accounts](/admin/service_accounts)
4445

docs/deep-search/index.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,13 @@ Conversation sharing is disabled by default. To enable conversation sharing, ask
6060
},
6161
```
6262

63-
64-
### Custom model configuration and BYOK (Bring Your Own Key)
63+
### Custom model configuration and BYOK (Bring Your Own Key)
6564
Deep Search is only available to customers using Sourcegraph’s built-in model gateway. Customers who configure and access their own models via BYOK cannot use the Deep Search feature.
6665

67-
## API access
66+
## Access control
67+
68+
Deep Search is [RBAC-enabled](/admin/access_control/). By default, all users have full read and write access for Deep Search, but this can be restricted by changing the default role permissions or by creating new custom roles.
69+
70+
## API
6871

6972
For programmatic access to Deep Search functionality, see the [Deep Search API documentation](/deep-search/api).

0 commit comments

Comments
 (0)