Files
threshold/website/content/docs/commands/groups/index.mdx
T
ad5ad69d54 [Assembly] Boundary Commands (CLI) docs (#3411)
* Add 'Commands (CLI)' docs

* Update index.mdx

Added Environment variables section

* Add 'connect' sub-folder structure

* Adding listen address and port environment variables

* add connect to the docs navigation

* docs: Add Florin's update to index

* docs: Fix links and typo

* Add front-matter to resolve the PR check issue

* Update postgres.mdx

Boundary helper for POSTGRES

* Completed 'boundary accounts' command docs

* Draft connection option documentatino for kube, http, and rdp (#3455)

* Style updates for consistency

* Clean up using partials

* Add 'ssh' doc & updated style for consistency

* Fix paste error

* Fix the format issue on 'connect ssh' doc

* Add 'auth-methods' command doc (#3520)

* Add the docs for 'logout', 'server', and 'dev' commands (#3524)

* Add the docs for 'logout', 'server', and 'dev' commands

* Update the front matter

* Add auth-tokens and authenticate command docs (#3575)

* Add config command docs (#3576)

* updates to the ssh helper command docs (#3523)

* updates to the ssh helper command docs

* docs: Fix code block

* docs: Add minor copy edits

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

* docs: Add worker commands

* docs: Update workers subcommands (#3598)

* docs: Update worker subcommands

* docs: Update certificate-authority subcommand

* doc: Fix syntax for code refererences

* docs: Add `users` commands (#3599)

* docs: Add `users` commands

* docs: Add more subcommands

* docs: Add `target` commands (#3608)

* Add command docs for 'credential-libraries' (#3610)

* Add 'credential-stores' command docs (#3611)

* Add 'credential-stores' command docs

* Add the output message

* Fix a typo

* Fix a typo

* Update the dummy token value

* docs: Add `storage-bucket` commands - update (#3615)

* docs: Add `sessions` commands (#3616)

* docs: Add `session-recordings` commands (#3617)

* Add 'credentials' command docs (#3619)

* Add 'credentials' command docs

* Fix typos

* docs: Add `scopes` commands (#3620)

* docs: Add `scopes` commands

* docs: Fix typos

* docs: Add `roles` commands (#3621)

* docs: Add `roles` commands

* docs: Add remaining subcommands

* Add 'database' command docs (#3628)

* Add 'database' command docs

* Update the format inconsistency

* docs: Add `managed-groups` commands (#3626)

* docs: Add `managed-groups` commands

* docs: Clarify description

* docs: Add `hosts` commands (#3629)

* docs: Add `host-sets` commands (#3630)

* docs: Add `host-sets` commands

* docs: Copy edits

* docs: Add `host-catalogs` commands (#3632)

* Add 'boundary groups' command docs (#3636)

---------

Co-authored-by: kevin-loehfelm <37027455+kevin-loehfelm@users.noreply.github.com>
Co-authored-by: kevin-loehfelm <kevin.loehfelm@hashicorp.com>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: Florin Cătălin Țiucra-Popa <106736683+FlorinTP@users.noreply.github.com>
Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
2023-09-12 14:37:31 -04:00

93 lines
2.5 KiB
Plaintext

---
layout: docs
page_title: groups - Command
description: |-
The "groups" command lets Boundary admin create and manage group resources.
---
# groups
Command: `boundary groups`
The `groups` command lets you create and manage group resources in Boundary.
A group in Boundary is a resource that represents a collection of users that are treated equally for the purposes of access control.
A group is a principal, which means it can be assigned to roles.
Roles assigned to a group are indirectly assigned to the users in the group, and users receive all permissions of the assigned roles.
You can define groups at the global, organization, or project scope.
## Examples
The following example creates a group, `group01` in a scope with the id `o_R0wbo0H6Zl`:
```shell-session
$ boundary groups create -name "group01" \
-description "A test group" \
-scope-id o_R0wbo0H6Zl
```
**Example output:**
<CodeBlockConfig hideClipboard>
```plaintext
Group information:
Created Time: Thu, 24 Aug 2023 09:51:44 PDT
Description: A test group
ID: g_XzlDiNLgoz
Name: group01
Updated Time: Thu, 24 Aug 2023 09:51:44 PDT
Version: 1
Scope:
ID: o_R0wbo0H6Zl
Name: quick-start-org
Parent Scope ID: global
Type: org
Authorized Actions:
no-op
read
update
delete
add-members
set-members
remove-members
```
</CodeBlockConfig>
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
Usage: boundary groups [sub command] [options] [args]
# ...
Subcommands:
add-members Add members to a group
create Create a group
delete Delete a group
list List a group
read Read a group
remove-members Remove members from a group
set-members Set the full contents of the members on a group
update Update a group
```
</CodeBlockConfig>
For more information, examples, and usage, click on the name
of the subcommand in the sidebar or one of the links below:
- [add-members](/boundary/docs/commands/groups/add-members)
- [create](/boundary/docs/commands/groups/create)
- [delete](/boundary/docs/commands/groups/delete)
- [list](/boundary/docs/commands/groups/list)
- [read](/boundary/docs/commands/groups/read)
- [remove-members](/boundary/docs/commands/groups/remove-members)
- [set-members](/boundary/docs/commands/groups/set-members)
- [update](/boundary/docs/commands/groups/update)