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.

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

[v15] Add auto role request docs #41056

Merged
merged 1 commit into from
Apr 30, 2024
Merged
Changes from all commits
Commits
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
47 changes: 47 additions & 0 deletions docs/pages/access-controls/access-requests/role-requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,53 @@ to the original set of roles.

## Next Steps

### Automatically request access for SSH

Once you have configured Role Access Requests,
`tsh ssh` is able to automatically create a Role Access Request for you when access is denied,
allowing you to skip the `tsh request search` and `tsh request create` steps.
If more than one role would grant access to the target node, you will be prompted
to select a role to request.

```code
$ tsh ssh --request-mode role alice@iot
ERROR: access denied to alice connecting to iot on cluster teleport.example.com

You do not currently have access to alice@iot, attempting to request access.

Choose role to request [node-access, node-access-alt]: node-access
Enter request reason: please
Creating request...

Waiting for request approval...

Approval received, reason="okay"
Getting updated certificates...

iot:~ alice$
```

Note that in order to make a Role Access Request this way, the role you request
access with must have `search_as_role` set so you can read the node you want to
ssh into.

```yaml
# requester.yaml
kind: role
version: v5
metadata:
name: requester
spec:
allow:
request:
roles:
- node-access
search_as_roles:
# does not need to match roles, just needs to be able to access nodes
# that you want to ssh into
- access
```

### Integrate with an external tool

With Teleport's Access Request plugins, users can manage Access Requests from
Expand Down
Loading