metalcloud-cli user list¶
List users with filtering and search options
Synopsis¶
List all users in the system with advanced filtering, searching, and sorting capabilities.
This command displays user information including ID, name, email, access level, archived status, creation date, and last login timestamp. Users can be filtered by various criteria and results can be sorted and searched through.
Filters: –archived Include archived users in the results (default: false) –filter-id Filter by specific user ID –filter-display-name Filter by user display name (partial matches) –filter-email Filter by email address (partial matches) –filter-account-id Filter by account ID –filter-infrastructure-id Filter by default infrastructure ID
Search and Sort: –search Search term applied across multiple fields –search-by Specify which fields to search in (comma-separated) –sort-by Sort results by field and direction (e.g., “id:ASC”, “email:DESC”)
Examples: metalcloud-cli user list metalcloud-cli user list –archived metalcloud-cli user list –filter-email “@company.com” metalcloud-cli user list –search “john” –search-by “displayName,email” metalcloud-cli user list –sort-by “createdTimestamp:DESC”
metalcloud-cli user list [flags]
Options¶
--archived Include archived users in the list.
--filter-account-id string Filter by account ID.
--filter-display-name string Filter by display name.
--filter-email string Filter by email.
--filter-id string Filter by user ID.
--filter-infrastructure-id string Filter by default infrastructure ID.
-h, --help help for list
--search string Search term to filter results.
--search-by string Fields to search by (e.g., 'displayName,email').
--sort-by string Sort by field (e.g., 'id:ASC'). (default "id:ASC")
Options inherited from parent commands¶
-k, --api_key string MetalCloud API key
-c, --config string Config file path
-d, --debug Set to enable debug logging
-e, --endpoint string MetalCloud API endpoint
-f, --format string Output format. Supported values are 'text','csv','md','json','yaml'. (default "text")
-i, --insecure_skip_verify Set to allow insecure transport
-l, --log_file string Log file path
-v, --verbosity string Log level verbosity (default "INFO")
SEE ALSO¶
metalcloud-cli user - Manage user accounts and their properties