Skip to content
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.

Sign up for GitHub

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

Update the list of preset roles #44606

Merged
merged 2 commits into from
Jul 29, 2024
Merged

Update the list of preset roles #44606

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b74176c
Update the list of preset roles
ptgott Jul 24, 2024
8dc9115
Update docs/pages/includes/preset-roles-table.mdx
ptgott Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions docs/pages/access-controls/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,9 @@ wrap up with creating your own role.

## Step 1/3. Add local users with preset roles

Teleport provides several preset roles: `editor`, `auditor`, and `access`.
Teleport provides several preset roles:

- The `editor` role authorizes users to modify cluster configuration.
- The `auditor` role authorizes users to view audit logs.
- The `access` role authorizes users to access cluster resources.

<Details title='Enterprise built in roles'>
Teleport Enterprise contains two additional preset roles: `reviewer` and `requester`.

- The `reviewer` role authorizes users to review Access Requests.
- The `requester` role authorizes users to request resources.
</Details>
(!docs/pages/includes/preset-roles-table.mdx!)

<Tabs>
<TabItem scope={["oss"]} label="Teleport Community Edition">
Expand Down
12 changes: 3 additions & 9 deletions docs/pages/access-controls/reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,9 @@ user:

## Preset roles

Teleport provides several pre-defined roles out-of-the-box:

| Role | Description |
| --- | --- |
| `editor` | Allows editing of cluster configuration settings. |
| `auditor`| Allows reading cluster events, audit logs, and playing back session records. |
| `access`| Allows access to cluster resources. |
| `requester`| Enterprise-only role that allows a user to create Access Requests. |
| `reviewer`| Enterprise-only role that allows review of Access Requests. |
Teleport provides several preset roles:

(!docs/pages/includes/preset-roles-table.mdx!)

### Role versions

Expand Down
13 changes: 13 additions & 0 deletions docs/pages/includes/preset-roles-table.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
| Role | Description |
| --- | --- |
| `access`| Allows access to cluster resources. |
| `auditor`| Allows reading cluster events, audit logs, and playing back session records. |
| `device-admin`| Used to manage trusted devices.|
| `device-enroll`| Used to grant device enrollment powers to users.|
| `editor` | Allows editing of cluster configuration settings. |
| `group-access`| Allows access to all user groups.|
| `requester`| Enterprise-only role that allows a user to create Access Requests. |
| `require-trusted-device`| Requires trusted device access to resources.|
| `reviewer`| Enterprise-only role that allows review of Access Requests. |
| `terraform-provider`|Allows the Teleport Terraform provider to configure all of its supported Teleport resources.|
ptgott marked this conversation as resolved.
Show resolved Hide resolved

Loading