2.84. hammer user

Manipulate users 

Usage:
    hammer user [OPTIONS] SUBCOMMAND [ARG] ...

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

Subcommands:
 access-token                  Managing personal access tokens
 add-role                      Assign a user role
 create                        Create a user
 delete, destroy               Delete a user
 info, show                    Show a user
 list, index                   List all users
 mail-notification             Managing personal mail notifications
 remove-role                   Remove a user role
 ssh-keys                      Managing User SSH Keys.
 update                        Update a user

Options:
 -h, --help                    Print help

2.84.1. hammer user access-token

Managing personal access tokens 

Usage:
    hammer user access-token [OPTIONS] SUBCOMMAND [ARG] ...

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

Subcommands:
 create                        Create a Personal Access Token for a user
 info, show                    Show a Personal Access Token for a user
 list, index                   List all Personal Access Tokens for a user
 revoke                        Revoke a Personal Access Token for a user

Options:
 -h, --help                    Print help

2.84.1.1. hammer user access-token create

Create a Personal Access Token for a user 

Usage:
    hammer user access-token create [OPTIONS]

Options:
 --expires-at EXPIRES_AT                 Expiry Date
 --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
 --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 USER_LOGIN                       User's login to search by
 --user-id USER_ID                       ID of the user
 -h, --help                              Print help

2.84.1.2. hammer user access-token info

Show a Personal Access Token for a user 

Usage:
    hammer user access-token <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
 --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 USER_LOGIN                       User's login to search by
 --user-id USER_ID                       ID of the user
 -h, --help                              Print help

Predefined field sets:
  -------------|-----|---------|-----
  FIELDS       | ALL | DEFAULT | THIN
  -------------|-----|---------|-----
  Id           | x   | x       | x
  Name         | x   | x       | x
  Active       | x   | x       |
  Expires at   | x   | x       |
  Created at   | x   | x       |
  Last used at | x   | x       |
  -------------|-----|---------|-----

2.84.1.3. hammer user access-token list

List all Personal Access Tokens for a user 

Usage:
    hammer user access-token <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
 --order ORDER                           Sort field and order, eg. ‘id DESC’
 --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
 --page PAGE                             Page number, starting at 1
 --per-page PER_PAGE                     Number of results per page to return
 --search SEARCH                         Filter results
 --user USER_LOGIN                       User's login to search by
 --user-id USER_ID                       ID of the user
 -h, --help                              Print help

Predefined field sets:
  -----------|-----|---------|-----
  FIELDS     | ALL | DEFAULT | THIN
  -----------|-----|---------|-----
  Id         | x   | x       | x
  Name       | x   | x       | x
  Active     | x   | x       |
  Expires at | x   | x       |
  -----------|-----|---------|-----

Search / Order fields:
  name                string
  user_id             integer

2.84.1.4. hammer user access-token revoke

Revoke a Personal Access Token for a user 

Usage:
    hammer user access-token revoke [OPTIONS]

Options:
 --id ID
 --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 USER_LOGIN                       User's login to search by
 --user-id USER_ID                       ID of the user
 -h, --help                              Print help