Skip to content

Commit 0d98bd2

Browse files
authored
Document Ask Fern RBAC feature (#706)
1 parent 8968e64 commit 0d98bd2

File tree

3 files changed

+20
-3
lines changed

3 files changed

+20
-3
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Role-based access control for Ask Fern
3+
description: Ask Fern respects your documentation's role-based access control settings.
4+
---
5+
6+
Ask Fern automatically respects the [role-based access control (RBAC) settings configured in your documentation](/docs/authentication/rbac). When users query Ask Fern, they only receive answers from documentation they have permission to access based on their assigned roles.
7+
8+
This works at all levels, from entire sections down to individual pages and conditional content within pages.

fern/products/ask-fern/pages/getting-started/how-it-works.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The main parts of the Ask Fern system are:
2727
models. They're stored in a database that serves as Ask Fern's search index.
2828
* **Query processing** – When users ask questions, Ask Fern vectorizes their
2929
query and searches the database to find the most relevant documentation and
30-
code chunks.
30+
code chunks. If you have [role-based access control](/docs/authentication/rbac) configured, Ask Fern filters results based on the user's permissions.
3131
* **Response generation** – Ask Fern uses the retrieved chunks as context to
3232
generate accurate answers with [citations](/ask-fern/features/citations) for the user. If the initial context isn't sufficient, it performs an additional keyword search.
3333

@@ -45,11 +45,12 @@ sequenceDiagram
4545
4646
U->>C: Submit question via Ask Fern searchbox
4747
C->>C: Convert query to vector
48+
C->>C: Check user roles (if RBAC enabled)
4849
C->>V: Search for relevant chunks
49-
V->>C: Return matching documents
50+
V->>C: Return matching documents user can access
5051
C->>A: Send query + context
5152
A->>V: Perform additional keyword search if needed
52-
V->>A: Return additional chunks
53+
V->>A: Return additional chunks user can access
5354
A->>A: Generate response
5455
A->>U: Return answer with citations
5556
```

fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,12 @@ Ask Fern helps you:
6262
Add custom documents to Ask Fern.
6363
</Card>
6464

65+
<Card
66+
title="Role-based access control"
67+
icon="regular shield-alt"
68+
href="/learn/ask-fern/configuration/documents"
69+
>
70+
Ask Fern enforces your documentation's role-based permissions.
71+
</Card>
72+
6573
</CardGroup>

0 commit comments

Comments
 (0)