Skip to content

Add docs for future assume time on access requests #35555

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

Merged
EdwardDowling merged 8 commits into from
Dec 14, 2023
Merged

Add docs for future assume time on access requests #35555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d196714
Add docs for future assume time on access requests
EdwardDowling Dec 8, 2023
c5517fd
Merge branch 'master' into edwarddowling/future-assume-roles-docs
EdwardDowling Dec 11, 2023
738e4df
Update docs/pages/access-controls/access-requests/access-request-conf…
EdwardDowling Dec 11, 2023
a4bad72
Update docs/pages/access-controls/access-requests/access-request-conf…
EdwardDowling Dec 14, 2023
de11be5
Update docs/pages/access-controls/access-requests/access-request-conf…
EdwardDowling Dec 14, 2023
3e0c6fb
Update docs/pages/access-controls/access-requests/access-request-conf…
EdwardDowling Dec 14, 2023
14056c1
Add link to RFC339 to access request doc
EdwardDowling Dec 14, 2023
195209d
Merge branch 'master' into edwarddowling/future-assume-roles-docs
EdwardDowling Dec 14, 2023
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
9 changes: 9 additions & 0 deletions docs/pages/access-controls/access-requests/access-request-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,15 @@ privileges:
earlier, whichever is shorter. Otherwise, set the duration of elevated
privileges to the session TTL.

### Setting when users can assume elevated privileges

When creating or reviewing Access Requests, you can specify the earliest time
that a user can assume elevated privileges by using the `--assume-start-time`
flag. This flag is available for the
[`tsh request create`](../../reference/cli/tsh.mdx#tsh-request-create) and [`tsh request
review`](../../reference/cli/tsh.mdx#tsh-request-review) commands. The format accepted
is defined in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339), e.g, `2023-12-12T23:20:50.52Z`.

### The `request.max_duration` field

The `max_duration` option indicates the maximum length of time that a user is
Expand Down
2 changes: 2 additions & 0 deletions docs/pages/reference/cli/tsh.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1077,6 +1077,7 @@ $ tsh request create [<flags>]
| `--request-ttl` | 1 hour | Relative duration like `5s`, `2m`, or `3h`, | Defines how long the Access Request will be in a `PENDING` state before becoming invalid |
| `--session-ttl` | Time left on current session | Relative duration like `5s`, `2m`, or `3h` | Defines how long the elevated session will be valid for |
| `--max-duration` | none | Relative duration like `5s`, `2m`, `3h`, or `7d` | Defines the maximum duration of the elevated session up to 7 days. The assigned role also must have `max_duration` option specified (optional) |
| `--assume-start-time` | none | String | Sets time roles can be assumed by requestor (RFC3339) |

<Admonition type="tip" title="Note">
The `--request-ttl` and `--session-ttl` values can not be greater than the
Expand Down Expand Up @@ -1140,6 +1141,7 @@ $ tsh request review [<flags>] <request-id>
| `--approve` | `false` | `true` or `false` | Review proposes approval |
| `--deny` | `false` | `true` or `false` | Review proposes denial |
| `--reason` | none | String | Review reason message |
| `--assume-start-time` | none | String | Sets time roles can be assumed by requestor (RFC3339) |
Comment thread
EdwardDowling marked this conversation as resolved.

### Arguments

Expand Down