From b8a769ed574ed42fc7f60e245146bd9d9982e9ce Mon Sep 17 00:00:00 2001 From: Simon Hellmayr Date: Thu, 11 Dec 2025 13:39:49 +0100 Subject: [PATCH 1/4] feat(replay): add docs for granular replay permissions --- .../explore/session-replay/access-control.mdx | 136 ++++++++++++++++++ docs/product/explore/session-replay/index.mdx | 2 + .../explore/session-replay/replay-details.mdx | 6 + 3 files changed, 144 insertions(+) create mode 100644 docs/product/explore/session-replay/access-control.mdx diff --git a/docs/product/explore/session-replay/access-control.mdx b/docs/product/explore/session-replay/access-control.mdx new file mode 100644 index 0000000000000..62d96a0b51721 --- /dev/null +++ b/docs/product/explore/session-replay/access-control.mdx @@ -0,0 +1,136 @@ +--- +title: Replay Access Control +sidebar_order: 75 +description: >- + Learn how to control which users can view session replays using granular permissions and allowlists. +--- + +Session Replay access control allows organization Managers and Owners to restrict 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 + +Replay access control works in conjunction with your existing Sentry permissions structure. 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 extra layer of security without replacing your existing permission model. If the feature is disabled, only standard Sentry permissions apply. + +**Permission Logic:** +``` +Can View Replay = (Standard Role/Team/Project Permissions) AND (On Allowlist OR Feature Disabled) +``` + +## Enabling Replay Access Control + +Organization Managers and Owners can enable replay access control in the organization settings: + +1. Navigate to **Settings > Organization Settings** +2. Locate the replay access control settings +3. Toggle on the setting to enable replay access restrictions +4. Once enabled, you'll see an option to manage the allowlist + + + +Only organization Managers and Owners can enable this feature and manage the allowlist. + + + +## Managing the Allowlist + +After enabling replay access control, you can specify which users are allowed to view replays: + +### Adding Users to the Allowlist + +1. In the replay access control settings, click to add users +2. Select users from your organization's member list +3. Save your changes + +Users added to the allowlist will be able to view replays (provided they also have the necessary role/team/project permissions). + +### Removing Users from the Allowlist + +1. In the replay access control settings, find the user you want to remove +2. Click the remove button next to their name +3. Confirm the removal + +Removed users will immediately lose access to viewing replays, even if they have other permissions that would normally grant access. + +### Best Practices + +- **Start with a small group**: When first enabling the feature, consider starting with a limited set of users and expanding gradually +- **Document your criteria**: Maintain clear internal documentation about who should be on the allowlist and why +- **Regular reviews**: Periodically review the allowlist to ensure it reflects current team needs +- **Communicate changes**: Let your team know when replay access control is enabled and who to contact for access + +## 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 + +These restrictions apply throughout Sentry, including: +- The Session Replay section +- Replay links in issue details +- Replay references in traces +- AI-powered replay summaries + +## Impact on AI Features + +Replay access control also affects AI-powered features in Sentry: + +### Seer Replay Summaries + +Users without replay access permissions cannot use [Seer](/product/ai-in-sentry/seer/) to generate or view AI-powered replay summaries. This ensures that users can't circumvent replay restrictions by accessing replay data through AI features. + +If you try to use Seer's replay summary feature without proper permissions, the feature will be unavailable. + + + +AI features respect the same permission boundaries as direct replay access. Users on the allowlist can use all replay-related AI features, while users not on the allowlist cannot. + + + +## Common Use Cases + +Organizations typically use replay access control for: + +### Compliance and Privacy + +Replays can contain sensitive user information or personally identifiable information (PII). Restricting access helps organizations: +- Meet compliance requirements (GDPR, HIPAA, etc.) +- Limit exposure of sensitive customer data +- Implement principle of least privilege + +### Cost Management + +Since replays contribute to your Sentry quota usage, limiting who can view them can help: +- Control replay-related costs +- Focus replay access on teams that need it most +- Manage resource allocation across teams + +### Security Policies + +Some organizations have strict security requirements that mandate: +- Limited access to production user sessions +- Audit trails for who can view customer data +- Graduated access levels based on role seniority + +### Trial and Beta Access + +When rolling out Session Replay capabilities: +- Test with a small group before wider deployment +- Manage beta access for new replay features +- Control feature rollout pace + +## Relationship to Other Permissions + +Replay access control works alongside Sentry's existing permission model: + +- **Organization-level roles**: Manager and Owner roles can manage the allowlist. All other roles must be on the allowlist to view replays (when enabled) +- **Team-level permissions**: Team membership still controls which projects and replays a user can access, but the allowlist adds an additional restriction +- **Project access**: Users must have access to a project through team membership and be on the allowlist to view that project's replays + +For more information about Sentry's permission model, see [Organization and User Management](/organization/membership/). diff --git a/docs/product/explore/session-replay/index.mdx b/docs/product/explore/session-replay/index.mdx index 98f746c26baf0..b767cd58ccd68 100644 --- a/docs/product/explore/session-replay/index.mdx +++ b/docs/product/explore/session-replay/index.mdx @@ -10,4 +10,6 @@ For browser-based applications, this includes static websites, single-page appli To learn more about which SDKs we support, please visit our docs for [Web](web/#supported-sdks) and [Mobile](mobile/#supported-sdks). + +Organizations can also manage who has access to view replays using [replay access control](access-control/), which provides granular user-based permissions on top of standard role and team permissions. diff --git a/docs/product/explore/session-replay/replay-details.mdx b/docs/product/explore/session-replay/replay-details.mdx index df73f41c3679d..b330c99d40a88 100644 --- a/docs/product/explore/session-replay/replay-details.mdx +++ b/docs/product/explore/session-replay/replay-details.mdx @@ -32,6 +32,12 @@ Sentry now provides **AI-powered replay summaries** that automatically analyze w - **AI Summary:** An LLM-powered description of the user's journey - **Chapters:** Each chapter summarizes related sets of breadcrumbs, network requests, and console logs, ordered by time range. Click a chapter to expand its contents and see the underlying events. Red chapters highlight errors, pink chapters highlight feedback + + +Replay summaries require replay access permissions. If your organization has enabled replay access control, only users on the allowlist will be able to view and generate AI summaries. Learn more about [replay access control](/product/explore/session-replay/access-control/). + + + ### Breadcrumbs The replay breadcrumbs show when key user interactions took place. Breadcrumbs are synced with the replay player and will auto-scroll as the video plays. From f7345e9bc617ef87bc40234c81718d5919164b0f Mon Sep 17 00:00:00 2001 From: Simon Hellmayr Date: Thu, 11 Dec 2025 13:42:17 +0100 Subject: [PATCH 2/4] remove superfluous docs --- .../explore/session-replay/access-control.mdx | 53 ++----------------- 1 file changed, 3 insertions(+), 50 deletions(-) diff --git a/docs/product/explore/session-replay/access-control.mdx b/docs/product/explore/session-replay/access-control.mdx index 62d96a0b51721..258ace3d8d19f 100644 --- a/docs/product/explore/session-replay/access-control.mdx +++ b/docs/product/explore/session-replay/access-control.mdx @@ -16,17 +16,12 @@ Replay access control works in conjunction with your existing Sentry permissions This means the allowlist adds an extra layer of security without replacing your existing permission model. If the feature is disabled, only standard Sentry permissions apply. -**Permission Logic:** -``` -Can View Replay = (Standard Role/Team/Project Permissions) AND (On Allowlist OR Feature Disabled) -``` - ## Enabling Replay Access Control Organization Managers and Owners can enable replay access control in the organization settings: 1. Navigate to **Settings > Organization Settings** -2. Locate the replay access control settings +2. Locate the **Restrict Replay Access** setting 3. Toggle on the setting to enable replay access restrictions 4. Once enabled, you'll see an option to manage the allowlist @@ -42,7 +37,7 @@ After enabling replay access control, you can specify which users are allowed to ### Adding Users to the Allowlist -1. In the replay access control settings, click to add users +1. In the **Restrict Replay Access** settings, click to add users 2. Select users from your organization's member list 3. Save your changes @@ -50,7 +45,7 @@ Users added to the allowlist will be able to view replays (provided they also ha ### Removing Users from the Allowlist -1. In the replay access control settings, find the user you want to remove +1. In the **Restrict Replay Access** settings, find the user you want to remove 2. Click the remove button next to their name 3. Confirm the removal @@ -92,45 +87,3 @@ If you try to use Seer's replay summary feature without proper permissions, the AI features respect the same permission boundaries as direct replay access. Users on the allowlist can use all replay-related AI features, while users not on the allowlist cannot. - -## Common Use Cases - -Organizations typically use replay access control for: - -### Compliance and Privacy - -Replays can contain sensitive user information or personally identifiable information (PII). Restricting access helps organizations: -- Meet compliance requirements (GDPR, HIPAA, etc.) -- Limit exposure of sensitive customer data -- Implement principle of least privilege - -### Cost Management - -Since replays contribute to your Sentry quota usage, limiting who can view them can help: -- Control replay-related costs -- Focus replay access on teams that need it most -- Manage resource allocation across teams - -### Security Policies - -Some organizations have strict security requirements that mandate: -- Limited access to production user sessions -- Audit trails for who can view customer data -- Graduated access levels based on role seniority - -### Trial and Beta Access - -When rolling out Session Replay capabilities: -- Test with a small group before wider deployment -- Manage beta access for new replay features -- Control feature rollout pace - -## Relationship to Other Permissions - -Replay access control works alongside Sentry's existing permission model: - -- **Organization-level roles**: Manager and Owner roles can manage the allowlist. All other roles must be on the allowlist to view replays (when enabled) -- **Team-level permissions**: Team membership still controls which projects and replays a user can access, but the allowlist adds an additional restriction -- **Project access**: Users must have access to a project through team membership and be on the allowlist to view that project's replays - -For more information about Sentry's permission model, see [Organization and User Management](/organization/membership/). From 133fae517b26cd1cb8a72e5ae9524440e82c30b3 Mon Sep 17 00:00:00 2001 From: Simon Hellmayr Date: Thu, 11 Dec 2025 13:43:07 +0100 Subject: [PATCH 3/4] cleanup --- .../explore/session-replay/access-control.mdx | 18 +++++++++--------- docs/product/explore/session-replay/index.mdx | 2 +- .../explore/session-replay/replay-details.mdx | 6 ------ 3 files changed, 10 insertions(+), 16 deletions(-) diff --git a/docs/product/explore/session-replay/access-control.mdx b/docs/product/explore/session-replay/access-control.mdx index 258ace3d8d19f..cf6e5b4cfb171 100644 --- a/docs/product/explore/session-replay/access-control.mdx +++ b/docs/product/explore/session-replay/access-control.mdx @@ -1,24 +1,24 @@ --- -title: Replay Access Control +title: Restricting Replay Access sidebar_order: 75 description: >- - Learn how to control which users can view session replays using granular permissions and allowlists. + Learn how to restrict which users can view session replays using granular permissions and allowlists. --- -Session Replay access control allows organization Managers and Owners to restrict 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. +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 -Replay access control works in conjunction with your existing Sentry permissions structure. When enabled, users must meet both requirements to view replays: +Restricting replay access works in conjunction with your existing Sentry permissions structure. 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 extra layer of security without replacing your existing permission model. If the feature is disabled, only standard Sentry permissions apply. -## Enabling Replay Access Control +## Restricting Replay Access -Organization Managers and Owners can enable replay access control in the organization settings: +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 @@ -33,7 +33,7 @@ Only organization Managers and Owners can enable this feature and manage the all ## Managing the Allowlist -After enabling replay access control, you can specify which users are allowed to view replays: +After enabling replay access restrictions, you can specify which users are allowed to view replays: ### Adding Users to the Allowlist @@ -56,7 +56,7 @@ Removed users will immediately lose access to viewing replays, even if they have - **Start with a small group**: When first enabling the feature, consider starting with a limited set of users and expanding gradually - **Document your criteria**: Maintain clear internal documentation about who should be on the allowlist and why - **Regular reviews**: Periodically review the allowlist to ensure it reflects current team needs -- **Communicate changes**: Let your team know when replay access control is enabled and who to contact for access +- **Communicate changes**: Let your team know when replay access is restricted and who to contact for access ## User Experience Without Permissions @@ -74,7 +74,7 @@ These restrictions apply throughout Sentry, including: ## Impact on AI Features -Replay access control also affects AI-powered features in Sentry: +Restricting replay access also affects AI-powered features in Sentry: ### Seer Replay Summaries diff --git a/docs/product/explore/session-replay/index.mdx b/docs/product/explore/session-replay/index.mdx index b767cd58ccd68..09fc742cabef5 100644 --- a/docs/product/explore/session-replay/index.mdx +++ b/docs/product/explore/session-replay/index.mdx @@ -11,5 +11,5 @@ For browser-based applications, this includes static websites, single-page appli To learn more about which SDKs we support, please visit our docs for [Web](web/#supported-sdks) and [Mobile](mobile/#supported-sdks). -Organizations can also manage who has access to view replays using [replay access control](access-control/), which provides granular user-based permissions on top of standard role and team permissions. +Organizations can also [restrict replay access](access-control/) to specific users, which provides granular user-based permissions on top of standard role and team permissions. diff --git a/docs/product/explore/session-replay/replay-details.mdx b/docs/product/explore/session-replay/replay-details.mdx index b330c99d40a88..df73f41c3679d 100644 --- a/docs/product/explore/session-replay/replay-details.mdx +++ b/docs/product/explore/session-replay/replay-details.mdx @@ -32,12 +32,6 @@ Sentry now provides **AI-powered replay summaries** that automatically analyze w - **AI Summary:** An LLM-powered description of the user's journey - **Chapters:** Each chapter summarizes related sets of breadcrumbs, network requests, and console logs, ordered by time range. Click a chapter to expand its contents and see the underlying events. Red chapters highlight errors, pink chapters highlight feedback - - -Replay summaries require replay access permissions. If your organization has enabled replay access control, only users on the allowlist will be able to view and generate AI summaries. Learn more about [replay access control](/product/explore/session-replay/access-control/). - - - ### Breadcrumbs The replay breadcrumbs show when key user interactions took place. Breadcrumbs are synced with the replay player and will auto-scroll as the video plays. From b821da684a779c2d229ae7794d11f873c3fdc6de Mon Sep 17 00:00:00 2001 From: Simon Hellmayr Date: Thu, 11 Dec 2025 13:45:59 +0100 Subject: [PATCH 4/4] cleanup --- .../explore/session-replay/access-control.mdx | 60 ++----------------- 1 file changed, 5 insertions(+), 55 deletions(-) diff --git a/docs/product/explore/session-replay/access-control.mdx b/docs/product/explore/session-replay/access-control.mdx index cf6e5b4cfb171..04bcde06b3b7d 100644 --- a/docs/product/explore/session-replay/access-control.mdx +++ b/docs/product/explore/session-replay/access-control.mdx @@ -1,20 +1,19 @@ --- title: Restricting Replay Access sidebar_order: 75 -description: >- - Learn how to restrict which users can view session replays using granular permissions and allowlists. +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 structure. When enabled, users must meet both requirements to view replays: +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 extra layer of security without replacing your existing permission model. If the feature is disabled, only standard Sentry permissions apply. +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. ## Restricting Replay Access @@ -22,8 +21,8 @@ Organization Managers and Owners can restrict replay access in the organization 1. Navigate to **Settings > Organization Settings** 2. Locate the **Restrict Replay Access** setting -3. Toggle on the setting to enable replay access restrictions -4. Once enabled, you'll see an option to manage the allowlist +3. Toggle on the **setting** to enable replay access restrictions +4. Once enabled, you'll see an input field that allows you to manage the allowlist @@ -31,33 +30,6 @@ Only organization Managers and Owners can enable this feature and manage the all -## Managing the Allowlist - -After enabling replay access restrictions, you can specify which users are allowed to view replays: - -### Adding Users to the Allowlist - -1. In the **Restrict Replay Access** settings, click to add users -2. Select users from your organization's member list -3. Save your changes - -Users added to the allowlist will be able to view replays (provided they also have the necessary role/team/project permissions). - -### Removing Users from the Allowlist - -1. In the **Restrict Replay Access** settings, find the user you want to remove -2. Click the remove button next to their name -3. Confirm the removal - -Removed users will immediately lose access to viewing replays, even if they have other permissions that would normally grant access. - -### Best Practices - -- **Start with a small group**: When first enabling the feature, consider starting with a limited set of users and expanding gradually -- **Document your criteria**: Maintain clear internal documentation about who should be on the allowlist and why -- **Regular reviews**: Periodically review the allowlist to ensure it reflects current team needs -- **Communicate changes**: Let your team know when replay access is restricted and who to contact for access - ## User Experience Without Permissions When a user doesn't have replay access permissions, they'll experience the following: @@ -65,25 +37,3 @@ When a user doesn't have replay access permissions, they'll experience the follo - **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 - -These restrictions apply throughout Sentry, including: -- The Session Replay section -- Replay links in issue details -- Replay references in traces -- AI-powered replay summaries - -## Impact on AI Features - -Restricting replay access also affects AI-powered features in Sentry: - -### Seer Replay Summaries - -Users without replay access permissions cannot use [Seer](/product/ai-in-sentry/seer/) to generate or view AI-powered replay summaries. This ensures that users can't circumvent replay restrictions by accessing replay data through AI features. - -If you try to use Seer's replay summary feature without proper permissions, the feature will be unavailable. - - - -AI features respect the same permission boundaries as direct replay access. Users on the allowlist can use all replay-related AI features, while users not on the allowlist cannot. - -