2.84.6. hammer user list
List all users
Usage: hammer user <list|index> [OPTIONS] Options: --auth-source-ldap AUTH_SOURCE_LDAP_NAME Name to search by --auth-source-ldap-id AUTH_SOURCE_LDAP_ID ID of LDAP authentication source --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 Scope by locations --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 Scope by organizations --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 --role ROLE_NAME User role name --role-id ROLE_ID ID of role --search SEARCH Filter results --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 Login | x | x | x Name | x | x | Email | x | x | Admin | x | x | Disabled | x | x | Last login | x | x | Authorized by | x | x | --------------|-----|---------|----- Search / Order fields: admin Values: true, false auth_source string auth_source_type string description text firstname string last_login_on datetime lastname string location string location_id integer login string mail string organization string organization_id integer role string role_id integer usergroup string
Usage:
hammer user <list|index> [OPTIONS]
Options:
--auth-source-ldap AUTH_SOURCE_LDAP_NAME Name to search by
--auth-source-ldap-id AUTH_SOURCE_LDAP_ID ID of LDAP authentication source
--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 Scope by locations
--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 Scope by organizations
--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
--role ROLE_NAME User role name
--role-id ROLE_ID ID of role
--search SEARCH Filter results
--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
Login | x | x | x
Name | x | x |
Email | x | x |
Admin | x | x |
Disabled | x | x |
Last login | x | x |
Authorized by | x | x |
--------------|-----|---------|-----
Search / Order fields:
admin Values: true, false
auth_source string
auth_source_type string
description text
firstname string
last_login_on datetime
lastname string
location string
location_id integer
login string
mail string
organization string
organization_id integer
role string
role_id integer
usergroup string