2026-08-11 11:22:55 -04:00
|
|
|
---
|
|
|
|
|
# Code generated by make gen. DO NOT EDIT.
|
|
|
|
|
title: groups edit
|
|
|
|
|
description: Edit a user group
|
|
|
|
|
---
|
|
|
|
|
|
2023-03-23 17:42:20 -05:00
|
|
|
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
|
|
|
|
|
|
|
|
Edit a user group
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
coder groups edit [flags] <name>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Options
|
|
|
|
|
|
2024-03-15 11:24:38 -05:00
|
|
|
### -n, --name
|
2023-03-23 17:42:20 -05:00
|
|
|
|
2024-03-15 11:24:38 -05:00
|
|
|
| | |
|
2025-01-03 18:12:59 +05:00
|
|
|
|------|---------------------|
|
2024-03-15 11:24:38 -05:00
|
|
|
| Type | <code>string</code> |
|
2023-03-23 17:42:20 -05:00
|
|
|
|
2024-03-15 11:24:38 -05:00
|
|
|
Update the group name.
|
2023-03-23 17:42:20 -05:00
|
|
|
|
|
|
|
|
### -u, --avatar-url
|
|
|
|
|
|
|
|
|
|
| | |
|
2025-01-03 18:12:59 +05:00
|
|
|
|------|---------------------|
|
2023-03-23 17:42:20 -05:00
|
|
|
| Type | <code>string</code> |
|
|
|
|
|
|
|
|
|
|
Update the group avatar.
|
|
|
|
|
|
2023-08-02 10:53:06 -05:00
|
|
|
### --display-name
|
|
|
|
|
|
|
|
|
|
| | |
|
2025-01-03 18:12:59 +05:00
|
|
|
|-------------|----------------------------------|
|
2023-08-02 10:53:06 -05:00
|
|
|
| Type | <code>string</code> |
|
|
|
|
|
| Environment | <code>$CODER_DISPLAY_NAME</code> |
|
|
|
|
|
|
|
|
|
|
Optional human friendly name for the group.
|
|
|
|
|
|
2024-03-15 11:24:38 -05:00
|
|
|
### -a, --add-users
|
2023-03-23 17:42:20 -05:00
|
|
|
|
2024-03-15 11:24:38 -05:00
|
|
|
| | |
|
2025-01-03 18:12:59 +05:00
|
|
|
|------|---------------------------|
|
2024-03-15 11:24:38 -05:00
|
|
|
| Type | <code>string-array</code> |
|
2023-03-23 17:42:20 -05:00
|
|
|
|
2024-03-15 11:24:38 -05:00
|
|
|
Add users to the group. Accepts emails or IDs.
|
2023-03-23 17:42:20 -05:00
|
|
|
|
|
|
|
|
### -r, --rm-users
|
|
|
|
|
|
|
|
|
|
| | |
|
2025-01-03 18:12:59 +05:00
|
|
|
|------|---------------------------|
|
2023-03-23 17:42:20 -05:00
|
|
|
| Type | <code>string-array</code> |
|
|
|
|
|
|
|
|
|
|
Remove users to the group. Accepts emails or IDs.
|
2024-07-01 11:04:45 -10:00
|
|
|
|
|
|
|
|
### -O, --org
|
|
|
|
|
|
|
|
|
|
| | |
|
2025-01-03 18:12:59 +05:00
|
|
|
|-------------|----------------------------------|
|
2024-07-01 11:04:45 -10:00
|
|
|
| Type | <code>string</code> |
|
|
|
|
|
| Environment | <code>$CODER_ORGANIZATION</code> |
|
|
|
|
|
|
|
|
|
|
Select which organization (uuid or name) to use.
|