Files

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

67 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

---
# Code generated by make gen. DO NOT EDIT.
title: "`coder 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
### -n, --name
2023-03-23 17:42:20 -05:00
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
2023-03-23 17:42:20 -05:00
Update the group name.
2023-03-23 17:42:20 -05:00
### -u, --avatar-url
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
2023-03-23 17:42:20 -05:00
Update the group avatar.
### --display-name
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_DISPLAY_NAME</code> |
Optional human friendly name for the group.
### -a, --add-users
2023-03-23 17:42:20 -05:00
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
2023-03-23 17:42:20 -05:00
Add users to the group. Accepts emails or IDs.
2023-03-23 17:42:20 -05:00
### -r, --rm-users
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
2023-03-23 17:42:20 -05:00
Remove users to the group. Accepts emails or IDs.
### -O, --org
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.