anchorectl usergroup

User Group Management Operations.

Every command on this page also accepts the global flags.

Subcommands

usergroup add — Create a new user group
usergroup delete — Delete a user group
usergroup get — Get a user group
usergroup list — List user groups
usergroup role — User Group Role Operations
usergroup update — Update a user group
usergroup user — User Group User Operations

usergroup add

Create a new user group.

anchorectl usergroup add NAME [flags]

Arguments

Argument	Description
`NAME`	The name of the user group.

Flags

Flag	Type	Environment variable	Default	Required	Description
`-d`, `--description`	string	`ANCHORECTL_USERGROUPPOST_DESCRIPTION`	`""`	No	The description of the user group.
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.

usergroup delete

Delete a user group.

anchorectl usergroup delete USER_GROUP [flags]

Aliases: del

Arguments

Argument	Description
`USER_GROUP`	The name or uuid of the user group.

Flags

Flag	Type	Environment variable	Default	Required	Description
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.

usergroup get

Get a user group.

anchorectl usergroup get USER_GROUP [flags]

Arguments

Argument	Description
`USER_GROUP`	The name or uuid of the user group.

Flags

Flag	Type	Environment variable	Default	Required	Description
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.

usergroup list

List user groups.

anchorectl usergroup list [flags]

Flags

Flag	Type	Environment variable	Default	Required	Description
`-a`, `--contains-account`	string	`ANCHORECTL_USERGROUP_CONTAINS_ACCOUNT`	`""`	No	Filter the user groups to only those that contain the specified domain name.
`-u`, `--contains-user`	string	`ANCHORECTL_USERGROUP_CONTAINS_USER`	`""`	No	Filter the user groups to only those that contain the specified user.
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.
`-g`, `--user-group-name`	string	`ANCHORECTL_USERGROUP_USER_GROUP_NAME`	`""`	No	Filter results to match the specified user group name.

usergroup role

User Group Role Operations.

anchorectl usergroup role [command]

Subcommands

usergroup role add — Add domain name and role(s) to this user group
usergroup role delete — Remove domain name and role(s) from this user group
usergroup role list — List accounts and roles configured in this user group

usergroup role add

Add domain name and role(s) to this user group.

anchorectl usergroup role add USER_GROUP DOMAIN_NAME [flags]

Arguments

Argument	Description
`DOMAIN_NAME`	The domain name.
`USER_GROUP`	The name or uuid of the user group.

Flags

Flag	Type	Environment variable	Default	Required	Description
`-i`, `--input`	string	`ANCHORECTL_INPUT`	`""`	No	Path to a JSON input file or - to read from stdin.
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.
`-r`, `--role`	string (repeatable)	`ANCHORECTL_ROLE`	`[]`	No	The RBAC role(s) that will be associated with the specified domain.

usergroup role delete

Remove domain name and role(s) from this user group.

anchorectl usergroup role delete USER_GROUP DOMAIN_NAME [flags]

Aliases: del

Arguments

Argument	Description
`DOMAIN_NAME`	The domain name.
`USER_GROUP`	The name or uuid of the user group.

Flags

Flag	Type	Environment variable	Default	Required	Description
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.
`-r`, `--role`	string (repeatable)	`ANCHORECTL_ROLE`	`[]`	No	The RBAC role(s) that will be associated with the specified domain name.

usergroup role list

List accounts and roles configured in this user group.

anchorectl usergroup role list USER_GROUP [flags]

Arguments

Argument	Description
`USER_GROUP`	The name or uuid of the user group.

Flags

Flag	Type	Environment variable	Default	Required	Description
`-i`, `--input`	string	`ANCHORECTL_INPUT`	`""`	No	Path to a JSON input file or - to read from stdin.
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.

usergroup update

Update a user group.

anchorectl usergroup update USER_GROUP [flags]

Arguments

Argument	Description
`USER_GROUP`	The name or uuid of the user group.

Flags

Flag	Type	Environment variable	Default	Required	Description
`-d`, `--description`	string	`ANCHORECTL_USERGROUP_DESCRIPTION`	`""`	Yes	The description of the user group.
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.

usergroup user

User Group User Operations.

anchorectl usergroup user [command]

Subcommands

usergroup user add — Add user(s) to this user group
usergroup user delete — Remove user(s) from this user group
usergroup user list — List users configured in this user group

usergroup user add

Add user(s) to this user group.

anchorectl usergroup user add USER_GROUP [flags]

Arguments

Argument	Description
`USER_GROUP`	The name or uuid of the user group.

Flags

Flag	Type	Environment variable	Default	Required	Description
`-i`, `--input`	string	`ANCHORECTL_INPUT`	`""`	No	Path to a JSON input file or - to read from stdin.
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.
`-u`, `--user`	string (repeatable)	`ANCHORECTL_USER`	`[]`	No	The username(s) that will be associated with the User Group.

usergroup user delete

Remove user(s) from this user group.

anchorectl usergroup user delete USER_GROUP [flags]

Aliases: del

Arguments

Argument	Description
`USER_GROUP`	The name or uuid of the user group.

Flags

Flag	Type	Environment variable	Default	Required	Description
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.
`-u`, `--user`	string (repeatable)	`ANCHORECTL_USER`	`[]`	No	The username(s) that will be removed from the User group.

usergroup user list

List users configured in this user group.

anchorectl usergroup user list USER_GROUP [flags]

Arguments

Argument	Description
`USER_GROUP`	The name or uuid of the user group.

Flags

Flag	Type	Environment variable	Default	Required	Description
`-i`, `--input`	string	`ANCHORECTL_INPUT`	`""`	No	Path to a JSON input file or - to read from stdin.
`-o`, `--output`	string	`ANCHORECTL_FORMAT`	`text`	No	The format to show the results. Allowable values: `text`, `json`, `json-raw`, `id`. See Output Formats.

Last modified September 22, 2026