Skip to content

Commit

Permalink
docs: add warning about auditor role (#10258)
Browse files Browse the repository at this point in the history
The default auditor role which is often applied to new users is
very permissive when it comes to sessions and recordings.

This may cause confusion when users attempt to set up RBAC for
sessions, because the more permissive role wins and the new
role doesn't appear to take effect.
  • Loading branch information
zmb3 committed Feb 16, 2022
1 parent d7ae31c commit de57fa4
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions docs/pages/access-controls/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ spec:
# The minimum amount of users that need to match the filter expression
# in order to satisfy the policy.
count: 1
# Moderated Sessions policy that dictates the ability to join sessions
join_sessions:
# Defines the name of the policy. The name serves only as an
Expand Down Expand Up @@ -374,11 +374,20 @@ The examples below illustrate how to restrict session access only for the user
who created the session.

<Details title="Version Warning: Before 8.1" opened={false}>
Teleport versions prior to 8.1 don't support the roles exemplified below.
You may to create such roles after an upgrade, but in the event of a cluster
Teleport versions prior to 8.1 don't support the roles shown below.
You may create these roles after upgrading, but in the event of a cluster
downgrade they will become invalid.
</Details>

<Admonition
type="warning"
title="Preset Auditor Role"
>
In order for these roles to take effect, you must ensure your user doesn't also
have a more permissive role, like the preset `auditor` role, which allows access
to all events, sessions, and session recordings.
</Admonition>

Role for restricted access to session recordings:

```yaml
Expand Down

0 comments on commit de57fa4

Please sign in to comment.