2023-09-12 11:37:31 -07:00
---
layout: docs
page_title: roles update - Command
2024-12-17 14:13:18 -05:00
description: >-
The "roles update" command updates an existing role resource.
2023-09-12 11:37:31 -07:00
---
2025-11-04 10:22:10 -05:00
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
2023-09-12 11:37:31 -07:00
# 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.
2024-06-17 12:09:33 -07:00
@include 'cmd-option-note.mdx'
