Skip to content

Commit 363d678

Browse files
stevenGravyptgott
andauthored
docs: update local users (#60189)
* docs: update local users * docs: update verbiage for local users Co-authored-by: Paul Gottschling <[email protected]> --------- Co-authored-by: Paul Gottschling <[email protected]>
1 parent 80f3073 commit 363d678

File tree

1 file changed

+12
-11
lines changed
  • docs/pages/zero-trust-access/management/admin

1 file changed

+12
-11
lines changed

docs/pages/zero-trust-access/management/admin/users.mdx

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,13 @@ A Teleport administrator creates Teleport user accounts and maps them to the rol
3131

3232
Let's look at this table:
3333

34-
| Teleport User | Allowed OS Logins | Description |
34+
| Teleport User | SSH Logins | Description |
3535
| - | - | - |
36-
| `joe` | `joe`, `root` | Teleport user `joe` can log in to member Nodes as user `joe` or `root` on the OS. |
37-
| `bob` | `bob` | Teleport user `bob` can log in to member Nodes only as OS user `bob`. |
38-
| `kim` | | If no OS login is specified, it defaults to the same name as the Teleport user, `kim`. |
36+
| `joe` | `joe`, `root` | Teleport user `joe` can log in as user `joe` or `root` on SSH servers. |
37+
| `bob` | `bob` | Teleport user `bob` can log in as user `bob` on SSH servers. |
38+
| `kim` | | Teleport user 'kim' has no designated SSH logins. |
39+
40+
SSH logins are some of the user traits available in Teleport roles. For all supported traits, see the reference for [`tctl users add`](../../../reference/cli/tctl.mdx#tctl-users-add).
3941

4042
Let's add a new user to Teleport using the `tctl` tool:
4143

@@ -66,10 +68,9 @@ NOTE: Make sure <proxy_host>:443 points at a Teleport proxy which users can acce
6668
The user completes registration by visiting this URL in their web browser,
6769
picking a password, and configuring multi-factor authentication. If the
6870
credentials are correct, the Teleport Auth Service generates and signs a new
69-
certificate, and the client stores this key and will use it for subsequent
70-
logins.
71+
user certificate.
7172

72-
The key will automatically expire after 12 hours by default, after which
73+
The certificate will automatically expire after 12 hours by default, after which
7374
the user will need to log back in with their credentials. This TTL can be
7475
configured to a different value.
7576

@@ -78,11 +79,11 @@ Once authenticated, the account will become visible via `tctl`:
7879
```code
7980
$ tctl users ls
8081
81-
# User Allowed Logins
82+
# User Roles
8283
# ---- --------------
83-
# admin admin,root
84-
# kim kim
85-
# joe joe,root
84+
# admin editor
85+
# kim access
86+
# joe access,editor
8687
```
8788

8889
## Editing users

0 commit comments

Comments
 (0)