Dan HeathandRobin Beck
69512baa8b
* docs: Add links for multi grant scopes * Update website/content/docs/commands/roles/create.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * docs: Add link to command docs --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
43 lines
1.3 KiB
Plaintext
43 lines
1.3 KiB
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.
|
|
- `-grant-scope-id=<string>` - The scope ID for any grants set on the role.
|
|
The `grant-scope-id` field is now deprecated in favor of multiple grant scope support using [add-grant-scopes](/boundary/docs/commands/roles/add-grant-scopes).
|
|
For more information, refer to [Version 0.15.0 feature deprecations and EOL](/boundary/docs/release-notes/v0_15_0#feature-deprecations-and-eol).
|
|
- `-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' |