feat(replay): add docs for granular replay permissions #15785
+41
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,39 @@ | ||||||
| --- | ||||||
| title: Restricting Replay Access | ||||||
| sidebar_order: 75 | ||||||
| description: "Restrict which users can view session replays using user-based allowlists." | ||||||
| --- | ||||||
|
|
||||||
| Restricting Session Replay access allows organization Managers and Owners to control who can view replays by creating an allowlist of authorized users. This feature provides an additional permission layer on top of existing role, team, and project permissions. | ||||||
|
|
||||||
| ## How It Works | ||||||
|
|
||||||
| Restricting replay access works in conjunction with your existing Sentry permissions. When enabled, users must meet both requirements to view replays: | ||||||
|
|
||||||
| 1. Have standard role/team/project permissions that would normally grant replay access | ||||||
| 2. Be included in the replay allowlist | ||||||
|
|
||||||
| This means the allowlist adds an additional layer of access control without replacing your existing permission model. If the feature is disabled, only standard Sentry permissions apply. | ||||||
|
Member
There was a problem hiding this comment. Maybe it would be good to provide an example here? For example, if a user doesn't have access to the project with replay data, adding them to the allowlist will not change this. |
||||||
|
|
||||||
| ## Restricting Replay Access | ||||||
|
|
||||||
| Organization Managers and Owners can restrict replay access in the organization settings: | ||||||
|
|
||||||
| 1. Navigate to **Settings > Organization Settings** | ||||||
| 2. Locate the **Restrict Replay Access** setting | ||||||
| 3. Toggle on the **setting** to enable replay access restrictions | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
| 4. Once enabled, you'll see an input field that allows you to manage the allowlist | ||||||
|
|
||||||
| <Alert level="info"> | ||||||
|
|
||||||
| Only organization Managers and Owners can enable this feature and manage the allowlist. | ||||||
|
|
||||||
| </Alert> | ||||||
|
|
||||||
| ## User Experience Without Permissions | ||||||
|
|
||||||
| When a user doesn't have replay access permissions, they'll experience the following: | ||||||
|
|
||||||
| - **Hidden UI components**: Replay-related buttons, menus, and navigation items won't be visible | ||||||
| - **Blocked API endpoints**: Direct API requests to replay endpoints will be denied | ||||||
| - **No replay data**: Replays won't appear in issue details or other contexts where they're normally shown | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
Member
There was a problem hiding this comment. I think this is the most important UX piece, maybe it could be the first bullet point? |
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.