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

Add tctl request create to the reference #46767

Merged
merged 1 commit into from
Oct 4, 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
39 changes: 39 additions & 0 deletions docs/pages/reference/cli/tctl.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1007,6 +1007,45 @@ $ tctl request approve [token]
$ tctl request approve request-id-1, request-id-2
```

## tctl request create

Create a pending Access Request.

```code
$ tctl request create <username>
```

### Arguments

- `<username>` - Name of target user (required).

### Flags

| Name | Default Value(s) | Allowed Value(s) | Description |
| - | - | - | - |
|`roles`|none|Comma-separated list of strings|Roles to be requested|
|`resource`|none|Comma-separated list of strings|Resource IDs to be requested|
|`reason`|none|String|Optional reason message|
|`dry-run`|none|Boolean|Don't actually generate the Access Request|

Use the `dry-run` flag if you want to validate whether Teleport can create an
Access Request for the user in the `username` argument, given the user's static
roles.

### Global flags

These flags are available for all commands `--debug, --config`. Run
`tctl help <subcommand>` or see the [Global Flags section](#tctl-global-flags).

### Examples

Create an Access Request for user `myuser` for the `prod` role, providing a
zmb3 marked this conversation as resolved.
Show resolved Hide resolved
reason:

```code
$ tctl request create myuser --roles=prod --reason="Fix an outage"
```

## tctl request deny

Denies a user's request:
Expand Down
Loading