Files
threshold/website/content/docs/commands/managed-groups/create.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

110 lines
3.1 KiB
Plaintext

---
layout: docs
page_title: managed-groups create - Command
description: |-
The "managed-groups create" command lets you create a new managed group.
---
# managed-groups create
Command: `managed-groups create`
The `managed-groups create` command lets you create a new managed group.
## Example
This example creates a managed group with the name `prodops` and the description `For ProdOps usage`:
```shell-session
$ boundary managed-groups create -name prodops -description "For ProdOps usage"
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary managed-groups create [options] [args]
Please see the typed subcommand help for detailed usage information.
Subcommands:
ldap Create an ldap managed group
oidc Create an oidc managed group
```
</CodeBlockConfig>
### Usages by type
You can create LDAP or OIDC managed groups.
<Tabs>
<Tab heading="LDAP">
The `boundary managed-groups create ldap` command lets you create LDAP managed groups.
#### Example
This example creates a LDAP managed group using the LDAP group name `admin` and the description `Ldap managed group for ProdOps`:
```shell-session
$ boundary managed-groups create ldap -group-names admin -description "Ldap managed group for ProdOps"
```
#### Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary managed-groups create ldap [options] [args]
```
</CodeBlockConfig>
#### Command options
- `-auth-method-id=<string>` - The auth-method resource to use for creating the managed group.
You can also specify the auth-method resource using the **BOUNDARY_AUTH_METHOD_ID** environment variable.
- `-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.
- `-name=<string>` - The name for the LDAP managed group.
</Tab>
<Tab heading="OIDC">
The `boundary managed-groups create oidc` command lets you create OIDC managed groups.
#### Example
This example creates a OIDC managed group using a filter and the description `Oidc managed group for ProdOps`:
```shell-session
$ boundary managed-groups create oidc -filter '"/token/email" == "doe@example.com"' -description "Oidc managed group for ProdOps"
```
#### Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary managed-groups create oidc [options] [args]
```
</CodeBlockConfig>
#### Command options
- `-auth-method-id=<string>` - The auth-method resource to use for creating the managed group.
You can also specify the auth-method resource using the **BOUNDARY_AUTH_METHOD_ID** environment variable.
- `-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.
- `-name=<string>` - The name to set for the OIDC managed group.
</Tab>
</Tabs>
@include 'cmd-option-note.mdx'