Skip to content

Commit

Permalink
Update the list of preset roles (#44606)
Browse files Browse the repository at this point in the history
* Update the list of preset roles

Closes #44086

In the Access Controls reference, mention preset roles based on
`constants.go`.

Since we use a list of preset roles in two guides, extract the table of
preset roles from the Access Controls reference into a partial.

* Update docs/pages/includes/preset-roles-table.mdx

Co-authored-by: Nic Klaassen <[email protected]>

---------

Co-authored-by: Nic Klaassen <[email protected]>
  • Loading branch information
ptgott and nklaassen authored Jul 29, 2024
1 parent 7f66098 commit 08b2c79
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 20 deletions.
13 changes: 2 additions & 11 deletions docs/pages/access-controls/getting-started.mdx
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
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
| Role | Description |
| --- | --- |
| `access`| Allows access to cluster resources. |
| `editor` | Allows editing of cluster configuration settings. |
| `auditor`| Allows reading cluster events, audit logs, and playing back session records. |
| `requester`| Enterprise-only role that allows a user to create Access Requests. |
| `reviewer`| Enterprise-only role that allows review of Access Requests. |
| `group-access`| Allows access to all user groups. |
| `device-admin`| Used to manage trusted devices. |
| `device-enroll`| Used to grant device enrollment powers to users. |
| `require-trusted-device`| Requires trusted device access to resources. |
| `terraform-provider`| Allows the Teleport Terraform provider to configure all of its supported Teleport resources. |

0 comments on commit 08b2c79

Please sign in to comment.