Skip to content

Commit

Permalink
Edit the Resource Requests guide (#51568)
Browse files Browse the repository at this point in the history
Closes #29347

The guide currently illustrates how to assign roles to new local users.
This change uses the `add-role-to-user.mdx` partial to include
instructions for Teleport clusters with SSO authentication connectors.
It edits the partial to include a parameter for the name of the user.
  • Loading branch information
ptgott authored Jan 31, 2025
1 parent f9907d3 commit e709e04
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,20 @@ available in Teleport Enterprise.
## Step 1/6. Grant roles to users

The built-in `requester` and `reviewer` roles have permissions to, respectively,
open and review Access Requests. Grant the `requester` and `reviewer` roles to
existing users, or create new users to test this feature. Make sure the
open and review Access Requests. Grant the `requester` and `reviewer` roles to
existing users, or create new users to test this feature. Make sure the
requester has a valid `login` so that they can view and access SSH nodes.

```code
$ tctl users add alice --roles requester --logins alice
$ tctl users add bob --roles reviewer
```

For the rest of the guide we will assume that the `requester` role has been
granted to a user named `alice` and the `reviewer` role has been granted to a
user named `bob`.

1. Assign the `requester` role to a user named `alice`:

(!docs/pages/includes/add-role-to-user.mdx role="requester" user="\`alice\`"!)

1. Repeat these steps to assign the `reviewer` role to a user named `bob`.

<Notice type="tip">

Consider defining custom roles to limit the scope of a requester or reviewer's
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/includes/add-role-to-user.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{ role="myrole" }}
Assign the `{{ role }}` role to your Teleport user by running the appropriate
{{ role="myrole" user="your Teleport user" }}
Assign the `{{ role }}` role to {{ user }} by running the appropriate
commands for your authentication provider:

<Tabs>
Expand Down

0 comments on commit e709e04

Please sign in to comment.