-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(replay): add docs for granular replay permissions #15785
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
shellmayr
wants to merge
6
commits into
master
Choose a base branch
from
shellmayr/feat/add-docs-for-granular-replay-permissions
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+43
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b8a769e
feat(replay): add docs for granular replay permissions
shellmayr f7345e9
remove superfluous docs
shellmayr 133fae5
cleanup
shellmayr b821da6
cleanup
shellmayr 78cf9d0
capitalize session replays and issue details, add example for how per…
shellmayr e2b82b8
don't capitalize owners and managers
shellmayr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,41 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| For example, if a user doesn't have access to a project containing replay data, adding them to the allowlist won't grant them access to those replays. Conversely, a user with full project access but not on the allowlist won't be able to view replays when the feature is enabled. | ||
|
|
||
| ## 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 | ||
shellmayr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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: | ||
|
|
||
| - **No replay data**: Replays won't appear in Issue Details or other contexts where they're normally shown | ||
| - **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 | ||
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.
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.
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.
Agree, a screenshot of the allowlist UI would also be helpful.
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.
Added an example here