2.87. hammer user-group

ユーザーロールを割り当てます。

Usage:
    hammer user-group add-role [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --role ROLE_NAME              User role name
 --role-id ROLE_ID
 -h, --help                    Print help

ユーザーを関連付けます。

Usage:
    hammer user-group add-user [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --user USER_LOGIN             User's login to search by
 --user-id USER_ID
 -h, --help                    Print help

ユーザーグループを関連付けます。

Usage:
    hammer user-group add-user-group [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --user-group USER_GROUP_NAME  Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                    Print help

ユーザーグループを作成します。

Usage:
    hammer user-group create [OPTIONS]

Options:
 --admin ADMIN                   Is an admin user group, can be modified by admins only
                                 One of true/false, yes/no, 1/0.
 --name NAME
 --role-ids ROLE_IDS             Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 --roles ROLE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 --user-group-ids USER_GROUP_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 --user-groups USER_GROUP_NAMES  Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 --user-ids USER_IDS             Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 --users USER_LOGINS             Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 -h, --help                      Print help

ユーザーグループを削除します。

Usage:
    hammer user-group <delete|destroy> [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 -h, --help                    Print help

ユーザーグループの外部ユーザーグループを表示および管理します。

Usage:
    hammer user-group external [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create an external user group linked to a user group
 delete, destroy               Delete an external user group
 info, show                    Show an external user group for user group
 list, index                   List all external user groups for user group
 refresh                       Refresh external user group
 update                        Update external user group

Options:
 -h, --help                    Print help

Usage:
    hammer user-group external create [OPTIONS]

Options:
 --auth-source AUTH_SOURCE_NAME          Name to search by
 --auth-source-id AUTH_SOURCE_ID         ID of linked authentication source
 --location LOCATION_NAME                Set the current location context for the request
 --location-id LOCATION_ID               Set the current location context for the request
 --location-title LOCATION_TITLE         Set the current location context for the request
 --name NAME                             External user group name
 --organization ORGANIZATION_NAME        Set the current organization context for the request
 --organization-id ORGANIZATION_ID       Set the current organization context for the request
 --organization-title ORGANIZATION_TITLE Set the current organization context for the request
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help

Usage:
    hammer user-group external <delete|destroy> [OPTIONS]

Options:
 --id ID                                 ID or name external user group
 --location LOCATION_NAME                Set the current location context for the request
 --location-id LOCATION_ID               Set the current location context for the request
 --location-title LOCATION_TITLE         Set the current location context for the request
 --name NAME                             Name to search by
 --organization ORGANIZATION_NAME        Set the current organization context for the request
 --organization-id ORGANIZATION_ID       Set the current organization context for the request
 --organization-title ORGANIZATION_TITLE Set the current organization context for the request
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help

Usage:
    hammer user-group external <info|show> [OPTIONS]

Options:
 --fields FIELDS                         Show specified fields or predefined field sets only. (See below)
                                         Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                         JSON is acceptable and preferred way for complex parameters
 --id ID                                 ID or name of external user group
 --location LOCATION_NAME                Set the current location context for the request
 --location-id LOCATION_ID               Set the current location context for the request
 --location-title LOCATION_TITLE         Set the current location context for the request
 --name NAME                             Name to search by
 --organization ORGANIZATION_NAME        Set the current organization context for the request
 --organization-id ORGANIZATION_ID       Set the current organization context for the request
 --organization-title ORGANIZATION_TITLE Set the current organization context for the request
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help

Predefined field sets:
  ------------|-----|---------|-----
  FIELDS      | ALL | DEFAULT | THIN
  ------------|-----|---------|-----
  Id          | x   | x       | x
  Name        | x   | x       | x
  Auth source | x   | x       |
  ------------|-----|---------|-----

Usage:
    hammer user-group external <list|index> [OPTIONS]

Options:
 --fields FIELDS                         Show specified fields or predefined field sets only. (See below)
                                         Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                         JSON is acceptable and preferred way for complex parameters
 --location LOCATION_NAME                Set the current location context for the request
 --location-id LOCATION_ID               Set the current location context for the request
 --location-title LOCATION_TITLE         Set the current location context for the request
 --organization ORGANIZATION_NAME        Set the current organization context for the request
 --organization-id ORGANIZATION_ID       Set the current organization context for the request
 --organization-title ORGANIZATION_TITLE Set the current organization context for the request
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help

Predefined field sets:
  ------------|-----|---------|-----
  FIELDS      | ALL | DEFAULT | THIN
  ------------|-----|---------|-----
  Id          | x   | x       | x
  Name        | x   | x       | x
  Auth source | x   | x       |
  ------------|-----|---------|-----

Usage:
    hammer user-group external refresh [OPTIONS]

Options:
 --fields FIELDS                         Show specified fields or predefined field sets only. (See below)
                                         Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                         JSON is acceptable and preferred way for complex parameters
 --id ID                                 ID or name of external user group
 --location LOCATION_NAME                Set the current location context for the request
 --location-id LOCATION_ID               Set the current location context for the request
 --location-title LOCATION_TITLE         Set the current location context for the request
 --name NAME                             Name to search by
 --organization ORGANIZATION_NAME        Set the current organization context for the request
 --organization-id ORGANIZATION_ID       Set the current organization context for the request
 --organization-title ORGANIZATION_TITLE Set the current organization context for the request
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help

Predefined field sets:
  ------------|-----|---------|-----
  FIELDS      | ALL | DEFAULT | THIN
  ------------|-----|---------|-----
  Name        | x   | x       | x
  Auth source | x   | x       |
  ------------|-----|---------|-----

Usage:
    hammer user-group external update [OPTIONS]

Options:
 --auth-source AUTH_SOURCE_NAME          Name to search by
 --auth-source-id AUTH_SOURCE_ID         ID of linked authentication source
 --id ID                                 ID or name of external user group
 --location LOCATION_NAME                Set the current location context for the request
 --location-id LOCATION_ID               Set the current location context for the request
 --location-title LOCATION_TITLE         Set the current location context for the request
 --name NAME                             Name to search by
 --new-name NEW_NAME                     External user group name
 --organization ORGANIZATION_NAME        Set the current organization context for the request
 --organization-id ORGANIZATION_ID       Set the current organization context for the request
 --organization-title ORGANIZATION_TITLE Set the current organization context for the request
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help

ユーザーグループを表示します。

Usage:
    hammer user-group <info|show> [OPTIONS]

Options:
 --fields FIELDS               Show specified fields or predefined field sets only. (See below)
                               Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                               JSON is acceptable and preferred way for complex parameters
 --id ID
 --name NAME                   Name to search by
 -h, --help                    Print help

Predefined field sets:
  --------------------------------|-----|---------|-----
  FIELDS                          | ALL | DEFAULT | THIN
  --------------------------------|-----|---------|-----
  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       |
  --------------------------------|-----|---------|-----

ユーザーグループの一覧を表示します。

Usage:
    hammer user-group <list|index> [OPTIONS]

Options:
 --fields FIELDS               Show specified fields or predefined field sets only. (See below)
                               Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                               JSON is acceptable and preferred way for complex parameters
 --order ORDER                 Sort field and order, eg. ‘id DESC’
 --page PAGE                   Page number, starting at 1
 --per-page PER_PAGE           Number of results per page to return, 'all' to return all results
 --search SEARCH               Filter results
 -h, --help                    Print help

Predefined field sets:
  -------|-----|---------|-----
  FIELDS | ALL | DEFAULT | THIN
  -------|-----|---------|-----
  Id     | x   | x       | x
  Name   | x   | x       | x
  Admin  | x   | x       |
  -------|-----|---------|-----

Search / Order fields:
  name                string
  role                string
  role_id             integer

ユーザーロールを削除します。

Usage:
    hammer user-group remove-role [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --role ROLE_NAME              User role name
 --role-id ROLE_ID
 -h, --help                    Print help

ユーザーの関連付けを解除します。

Usage:
    hammer user-group remove-user [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --user USER_LOGIN             User's login to search by
 --user-id USER_ID
 -h, --help                    Print help

ユーザーグループの関連付けを解除します。

Usage:
    hammer user-group remove-user-group [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --user-group USER_GROUP_NAME  Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                    Print help

ユーザーグループを更新します。

Usage:
    hammer user-group update [OPTIONS]

Options:
 --admin ADMIN                   Is an admin user group, can be modified by admins only
                                 One of true/false, yes/no, 1/0.
 --id ID
 --name NAME                     Name to search by
 --new-name NEW_NAME
 --role-ids ROLE_IDS             Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 --roles ROLE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 --user-group-ids USER_GROUP_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 --user-groups USER_GROUP_NAMES  Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 --user-ids USER_IDS             Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 --users USER_LOGINS             Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                 JSON is acceptable and preferred way for complex parameters
 -h, --help                      Print help