Skip to content

orca group

Manage Keystone groups.

The reference below is generated from the live CLI by mkdocs-click. It always reflects the version installed.

orca group

Manage groups (Keystone v3).

Usage:

orca group [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add-user: [deprecated, use 'group user add' instead]
  • create: Create a group.
  • delete: Delete a group.
  • list: List groups.
  • member: Inspect users belonging to a group.
  • member-list: [deprecated, use 'group member list' instead]
  • remove-user: [deprecated, use 'group user remove' instead]
  • set: Update a group.
  • show: Show group details.
  • user: Manage user membership of a group.

orca group add-user

Add a user to a group.

Usage:

orca group add-user [OPTIONS] GROUP_ID USER_ID

Options:

Name Type Description Default
--help boolean Show this message and exit. False

orca group create

Create a group.

Usage:

orca group create [OPTIONS] NAME

Options:

Name Type Description Default
--description text N/A None
--domain text N/A None
--help boolean Show this message and exit. False

orca group delete

Delete a group.

Usage:

orca group delete [OPTIONS] GROUP_ID

Options:

Name Type Description Default
--yes, -y boolean N/A False
--help boolean Show this message and exit. False

orca group list

List groups.

Usage:

orca group list [OPTIONS]

Options:

Name Type Description Default
--domain text Filter by domain ID. None
--noindent boolean Disable JSON indentation. False
--max-width integer Maximum table width (0 = unlimited). None
--fit-width boolean Fit table to terminal width. False
--column, -c text Column to include (repeatable). Shows all if omitted. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca group member

Inspect users belonging to a group.

Usage:

orca group member [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • list: List users in a group.
orca group member list

List users in a group.

Usage:

orca group member list [OPTIONS] GROUP_ID

Options:

Name Type Description Default
--noindent boolean Disable JSON indentation. False
--max-width integer Maximum table width (0 = unlimited). None
--fit-width boolean Fit table to terminal width. False
--column, -c text Column to include (repeatable). Shows all if omitted. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca group member-list

List users in a group.

Usage:

orca group member-list [OPTIONS] GROUP_ID

Options:

Name Type Description Default
--noindent boolean Disable JSON indentation. False
--max-width integer Maximum table width (0 = unlimited). None
--fit-width boolean Fit table to terminal width. False
--column, -c text Column to include (repeatable). Shows all if omitted. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca group remove-user

Remove a user from a group.

Usage:

orca group remove-user [OPTIONS] GROUP_ID USER_ID

Options:

Name Type Description Default
--help boolean Show this message and exit. False

orca group set

Update a group.

Usage:

orca group set [OPTIONS] GROUP_ID

Options:

Name Type Description Default
--name text N/A None
--description text N/A None
--help boolean Show this message and exit. False

orca group show

Show group details.

Usage:

orca group show [OPTIONS] GROUP_ID

Options:

Name Type Description Default
--noindent boolean Disable JSON indentation. False
--max-width integer Maximum table width (0 = unlimited). None
--fit-width boolean Fit table to terminal width. False
--column, -c text Column to include (repeatable). Shows all if omitted. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca group user

Manage user membership of a group.

Usage:

orca group user [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add: Add a user to a group.
  • remove: Remove a user from a group.
orca group user add

Add a user to a group.

Usage:

orca group user add [OPTIONS] GROUP_ID USER_ID

Options:

Name Type Description Default
--help boolean Show this message and exit. False
orca group user remove

Remove a user from a group.

Usage:

orca group user remove [OPTIONS] GROUP_ID USER_ID

Options:

Name Type Description Default
--help boolean Show this message and exit. False