Files
threshold/website/content/docs/commands/roles/update.mdx
T
Johan Brandhorst-SatzkornandJeff Mitchell c6f3c375f3 api: remove deprecated grant_scope_id field (#4886)
* api: remove deprecated grant_scope_id field

The grant_scope_id field was deprecated in 0.15.0, so we can remove
it for 0.17.0.

* Fix tests

* Fix more tests

* Remove an option and some related code that stuck around

* Fix bats tests

---------

Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
2024-06-17 12:09:33 -07:00

41 lines
981 B
Plaintext

---
layout: docs
page_title: roles update - Command
description: |-
The "roles update" command lets you update an existing role.
---
# roles update
Command: `roles update`
The `roles update` command lets you update an existing role.
## Example
This example updates a role with the ID `r_1234567890` to add the name `devops` and the description `Role for DevOps`:
```shell-session
$ boundary roles update -id r_1234567890 -name "devops" -description "Role for DevOps"
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary roles update [options] [args]
```
</CodeBlockConfig>
### Command options
- `-description=<string>` - The description to set on the role.
- `-id=<string>` - The ID of the role you want to update.
- `-name=<string>` - The name to set on the role.
- `-version=<int>` - The version of the role you want to update.
If you do not specify a version, the command performs a check-and-set automatically.
@include 'cmd-option-note.mdx'