Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 93. user-group

Manage user groups

Usage 

# hammer user-group [OPTIONS] SUBCOMMAND [ARG] ...
Copy to Clipboard Toggle word wrap

Options

  • -h, --help – Print help

93.1. user-group add-role
Copy link

Assign a user role

Usage 

# hammer user-group add-role [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --role VALUE – User role name
  • --role-id NUMBER
  • -h, --help – Print help

93.2. user-group add-user
Copy link

Associate an user

Usage 

# hammer user-group add-user [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --user VALUE – User`s login to search by
  • --user-id NUMBER
  • -h, --help – Print help

93.3. user-group add-user-group
Copy link

Associate an user group

Usage 

# hammer user-group add-user-group [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --user-group VALUE – Name to search by
  • --user-group-id NUMBER
  • -h, --help – Print help

93.4. user-group create
Copy link

Create a user group

Usage 

# hammer user-group create [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --admin BOOLEAN – Is an admin user group, can be modified by admins only
  • --name VALUE
  • --role-ids LIST
  • --roles LIST
  • --user-group-ids LIST
  • --user-groups LIST
  • --user-ids LIST
  • --users LIST
  • -h, --help – Print help

93.5. user-group delete
Copy link

Delete a user group

Usage 

# hammer user-group <delete|destroy> [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • -h, --help – Print help

93.6. user-group external
Copy link

View and manage user group’s external user groups

Usage 

# hammer user-group external [OPTIONS] SUBCOMMAND [ARG] ...
Copy to Clipboard Toggle word wrap

Options

  • -h, --help – Print help

93.6.1. user-group external create
Copy link

Create an external user group linked to a user group

Usage 

# hammer user-group external create [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --auth-source VALUE – Name to search by
  • --auth-source-id NUMBER – ID of linked authentication source
  • --name VALUE – External user group name
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help

93.6.2. user-group external delete
Copy link

Delete an external user group

Usage 

# hammer user-group external <delete|destroy> [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE – ID or name external user group
  • --name VALUE – Name to search by
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help

93.6.3. user-group external info
Copy link

Show an external user group for user group

Usage 

# hammer user-group external <info|show> [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – ID or name of external user group
  • --name VALUE – Name to search by
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help

Predefined field sets

Expand
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Auth source

x

x

 

93.6.4. user-group external list
Copy link

List all external user groups for user group

Usage 

# hammer user-group external <list|index> [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help

Predefined field sets

Expand
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Auth source

x

x

 

93.6.5. user-group external refresh
Copy link

Refresh external user group

Usage 

# hammer user-group external refresh [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – ID or name of external user group
  • --name VALUE – Name to search by
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help

Predefined field sets

Expand
FIELDSALLDEFAULTTHIN

Name

x

x

x

Auth source

x

x

 

93.6.6. user-group external update
Copy link

Update external user group

Usage 

# hammer user-group external update [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --auth-source VALUE – Name to search by
  • --auth-source-id NUMBER – ID of linked authentication source
  • --id VALUE – ID or name of external user group
  • --name VALUE – External user group name
  • --new-name VALUE – External user group name
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help

93.7. user-group info
Copy link

Show a user group

Usage 

# hammer user-group <info|show> [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --name VALUE – Name to search by
  • -h, --help – Print help

Predefined field sets

Expand
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Admin

x

x

 

Users/

x

x

 

User groups/usergroup

x

x

 

User groups/id

x

x

 

User groups/roles/

x

x

 

Inherited user groups/usergroup

x

x

 

Inherited user groups/id

x

x

 

Inherited user groups/roles/

x

x

 

External user groups/

x

x

 

Roles/

x

x

 

Created at

x

x

 

Updated at

x

x

 

93.8. user-group list
Copy link

List all user groups

Usage 

# hammer user-group <list|index> [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help

Predefined field sets

Expand
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Admin

x

x

 

Search and order fields

  • id – integer
  • name – string
  • role – string
  • role_id – integer

93.9. user-group remove-role
Copy link

Remove a user role

Usage 

# hammer user-group remove-role [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --role VALUE – User role name
  • --role-id NUMBER
  • -h, --help – Print help

93.10. user-group remove-user
Copy link

Disassociate an user

Usage 

# hammer user-group remove-user [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --user VALUE – User`s login to search by
  • --user-id NUMBER
  • -h, --help – Print help

93.11. user-group remove-user-group
Copy link

Disassociate an user group

Usage 

# hammer user-group remove-user-group [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --user-group VALUE – Name to search by
  • --user-group-id NUMBER
  • -h, --help – Print help

93.12. user-group update
Copy link

Update a user group

Usage 

# hammer user-group update [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --admin BOOLEAN – Is an admin user group, can be modified by admins only
  • --id VALUE
  • --name VALUE
  • --new-name VALUE
  • --role-ids LIST
  • --roles LIST
  • --user-group-ids LIST
  • --user-groups LIST
  • --user-ids LIST
  • --users LIST
  • -h, --help – Print help
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat