ad5ad69d54
* 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>
112 lines
3.3 KiB
Plaintext
112 lines
3.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: managed-groups update - Command
|
|
description: |-
|
|
The "managed-groups update" command lets you update an existing managed group.
|
|
---
|
|
|
|
# managed-groups update
|
|
|
|
Command: `managed-groups update`
|
|
|
|
The `managed-groups update` command lets you update an existing managed group.
|
|
|
|
## Example
|
|
|
|
This example updates a managed group with the ID `_1234567890` to include the name `prodops` and the description `For ProdOps usage`:
|
|
|
|
```shell-session
|
|
$ boundary managed-groups update -id _1234567890 -name "prodops" -description "For ProdOps usage"
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary managed-groups update [options] [args]
|
|
|
|
Please see the managed-groups subcommand help for detailed usage information.
|
|
|
|
Subcommands:
|
|
ldap Update an ldap managed group
|
|
oidc Update an oidc managed group
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Usages by type
|
|
|
|
You can update LDAP or OIDC managed groups.
|
|
|
|
<Tabs>
|
|
<Tab heading="LDAP">
|
|
|
|
The `boundary managed-groups update ldap` command lets you update LDAP managed groups.
|
|
|
|
#### Example
|
|
|
|
This example updates a LDAP managed group with the ID `acctldap_1234567890` to add the name `devops` and the description `Ldap managed group for DevOps`:
|
|
|
|
```shell-session
|
|
$ boundary managed-groups update ldap -id acctldap_1234567890 -name "devops" -description "Ldap managed group for DevOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary managed-groups update ldap [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### Command options
|
|
|
|
- `-description=<string>` - The description to set for the LDAP managed group.
|
|
- `-group-names=<string>` - The LDAP group names against which an LDAP account's associated groups are evaluated to determine membership.
|
|
Boundary evaluates managed group membership when you log in.
|
|
You can specify multiple group names.
|
|
- `-id=<string>` - The ID of the LDAP managed group to update.
|
|
- `-name=<string>` - The name to set for the LDAP managed group.
|
|
- `-version=<int>` - The version of the LDAP managed group to update.
|
|
If you do not specify a version, the command automatically performs a check-and-set.
|
|
|
|
</Tab>
|
|
<Tab heading="OIDC">
|
|
|
|
The `boundary managed-groups update oidc` command lets you update OIDC managed groups.
|
|
|
|
#### Example
|
|
|
|
This example updates an OIDC managed group with the ID `acctoidc_1234567890` to add the name `devops` and the description `Oidc managed group for DevOps`:
|
|
|
|
```shell-session
|
|
$ boundary managed-groups update oidc -id acctoidc_1234567890 -name "devops" -description "Oidc managed group for DevOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary managed-groups update oidc [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### Command options
|
|
|
|
- `-description=<string>` - The description to set for the OIDC managed group.
|
|
- `-filter=<string>` - The filter that defines the criteria against which an account's OIDC token and user info are evaluated to determine if it is a member of the OIDC managed group.
|
|
Boundary evaluates managed group membership when you log in.
|
|
- `-id=<string>` - The ID of the OIDC managed group you want to update.
|
|
- `-name=<string>` - The name to set for the OIDC managed group.
|
|
- `-version=<int>` - The version of the OIDC managed group to update.
|
|
If you do not specify a version, the command performs a check-and-set automatically.
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
@include 'cmd-option-note.mdx' |