Files
coder/docs/cli/groups_edit.md
Steven Masley 4c1e63aae8 feat: add display_name field to groups (#8740)
* feat: add display_name field to groups

This is a non-unique human friendly group name for display
purposes. This means a display name can be used instead of
using an environment var to remap groups with OIDC names to
Coder names. Now groups can retain the OIDC name for mapping,
and use a display name for display purposes.
2023-08-02 10:53:06 -05:00

55 lines
1.0 KiB
Markdown
Generated

<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups edit
Edit a user group
## Usage
```console
coder groups edit [flags] <name>
```
## Options
### -a, --add-users
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Add users to the group. Accepts emails or IDs.
### -u, --avatar-url
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Update the group avatar.
### --display-name
| | |
| ----------- | -------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_DISPLAY_NAME</code> |
Optional human friendly name for the group.
### -n, --name
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Update the group name.
### -r, --rm-users
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Remove users to the group. Accepts emails or IDs.