Users
Manage users. Root access required.
Usage:
shell
humioctl users [command]Use humioctl users [command] --help for more information about a command.
Table: Users commands
| Parameter | Description |
|---|---|
Add | Add a user. Root access required. |
List | List all users. Root access required. |
Remove | Remove a user. Root access required. |
Show | Show details about a user. Root access required. |
Update | Update a user's settings. Root access required. |
Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for users |
Table: Global flags
| Parameter | Description |
|---|---|
-a,--address string | The HTTP address of the Humio cluster. Overrides the value in your config file. |
--ca-certificate-file string | File path to a file containing the CA certificate in PEM format. Overrides the value in your config file. |
-c, --config string |
Config file (default is
$HOME/.humio/config.yaml)
|
--format string | Change output format of commands, if supported. Valid formats: json |
--insecure | By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation. |
-u, --profile string | Name of the config profile to use |
--proxy-organization string | Commands are executed in the specified organization. |
-t, --token string | The API token to use when talking to Humio. Overrides the value in your config file. |
--token-file string | File path to a file containing the API token. Overrides the value in your config file and the value of --token. |
--unix-socket-proxy string | Path to a unix socket to use as an HTTP proxy. |
Add
Add a user.
Usage:
shell
humioctl users add [flags] <username>Table: Local flags
| Parameter | Description |
|---|---|
--company string | The company where the user works. |
--country-code string | A two-letter country code. |
--email string | The user's email address. Does not change the username if the email is used as the username. |
-h, --help | Help for add |
--name string | The full name of the user. |
--picture url | A URL to an avatar for the user. |
--root | Grant root access to the user. |
Hide global flags
Table: Global flags
| Parameter | Description |
|---|---|
-a,--address string | The HTTP address of the Humio cluster. Overrides the value in your config file. |
--ca-certificate-file string | File path to a file containing the CA certificate in PEM format. Overrides the value in your config file. |
-c, --config string |
Config file (default is
$HOME/.humio/config.yaml)
|
--format string | Change output format of commands, if supported. Valid formats: json |
--insecure | By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation. |
-u, --profile string | Name of the config profile to use |
--proxy-organization string | Commands are executed in the specified organization. |
-t, --token string | The API token to use when talking to Humio. Overrides the value in your config file. |
--token-file string | File path to a file containing the API token. Overrides the value in your config file and the value of --token. |
--unix-socket-proxy string | Path to a unix socket to use as an HTTP proxy. |
List
List all users.
Usage:
shell
humioctl users list [flags]Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for list |
Hide global flags
Table: Global flags
| Parameter | Description |
|---|---|
-a,--address string | The HTTP address of the Humio cluster. Overrides the value in your config file. |
--ca-certificate-file string | File path to a file containing the CA certificate in PEM format. Overrides the value in your config file. |
-c, --config string |
Config file (default is
$HOME/.humio/config.yaml)
|
--format string | Change output format of commands, if supported. Valid formats: json |
--insecure | By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation. |
-u, --profile string | Name of the config profile to use |
--proxy-organization string | Commands are executed in the specified organization. |
-t, --token string | The API token to use when talking to Humio. Overrides the value in your config file. |
--token-file string | File path to a file containing the API token. Overrides the value in your config file and the value of --token. |
--unix-socket-proxy string | Path to a unix socket to use as an HTTP proxy. |
Remove
Remove a user.
Usage:
shell
humioctl users remove [flags]Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for remove |
Hide global flags
Table: Global flags
| Parameter | Description |
|---|---|
-a,--address string | The HTTP address of the Humio cluster. Overrides the value in your config file. |
--ca-certificate-file string | File path to a file containing the CA certificate in PEM format. Overrides the value in your config file. |
-c, --config string |
Config file (default is
$HOME/.humio/config.yaml)
|
--format string | Change output format of commands, if supported. Valid formats: json |
--insecure | By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation. |
-u, --profile string | Name of the config profile to use |
--proxy-organization string | Commands are executed in the specified organization. |
-t, --token string | The API token to use when talking to Humio. Overrides the value in your config file. |
--token-file string | File path to a file containing the API token. Overrides the value in your config file and the value of --token. |
--unix-socket-proxy string | Path to a unix socket to use as an HTTP proxy. |
Show
Show details about a user.
Usage:
shell
humioctl users show [flags] <username>Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for show |
Hide global flags
Table: Global flags
| Parameter | Description |
|---|---|
-a,--address string | The HTTP address of the Humio cluster. Overrides the value in your config file. |
--ca-certificate-file string | File path to a file containing the CA certificate in PEM format. Overrides the value in your config file. |
-c, --config string |
Config file (default is
$HOME/.humio/config.yaml)
|
--format string | Change output format of commands, if supported. Valid formats: json |
--insecure | By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation. |
-u, --profile string | Name of the config profile to use |
--proxy-organization string | Commands are executed in the specified organization. |
-t, --token string | The API token to use when talking to Humio. Overrides the value in your config file. |
--token-file string | File path to a file containing the API token. Overrides the value in your config file and the value of --token. |
--unix-socket-proxy string | Path to a unix socket to use as an HTTP proxy. |
Update
Update a user's settings.
Usage:
shell
humioctl users update [flags] <username>Table: Local flags
| Parameter | Description |
|---|---|
--company string | The company where the user works. |
--country-code string | A two-letter country code. |
--email string | The user's email address. Does not change the username if the email is used as the username. |
-h, --help | Help for update |
--name string | The full name of the user. |
--picture url | A URL to an avatar for the user. |
--root | Grant root access to the user. |
Hide global flags
Table: Global flags
| Parameter | Description |
|---|---|
-a,--address string | The HTTP address of the Humio cluster. Overrides the value in your config file. |
--ca-certificate-file string | File path to a file containing the CA certificate in PEM format. Overrides the value in your config file. |
-c, --config string |
Config file (default is
$HOME/.humio/config.yaml)
|
--format string | Change output format of commands, if supported. Valid formats: json |
--insecure | By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation. |
-u, --profile string | Name of the config profile to use |
--proxy-organization string | Commands are executed in the specified organization. |
-t, --token string | The API token to use when talking to Humio. Overrides the value in your config file. |
--token-file string | File path to a file containing the API token. Overrides the value in your config file and the value of --token. |
--unix-socket-proxy string | Path to a unix socket to use as an HTTP proxy. |