.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH nethsm-user 1  "nethsm-user " 
.SH NAME
nethsm\-user \- Operate on users of a device
.SH SYNOPSIS
\fBnethsm user\fR [\fB\-a\fR|\fB\-\-auth\-passphrase\-file\fR] [\fB\-c\fR|\fB\-\-config\fR] [\fB\-l\fR|\fB\-\-label\fR] [\fB\-u\fR|\fB\-\-user\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR>
.SH DESCRIPTION
Operate on users of a device
.PP
Allows to add and remove users, retrieve information about them, set their passphrases and set or unset tags for them.
.PP
Users may exist in specific scopes: system\-wide or in namespaces (see "nethsm namespace").
The use of a namespace is indicated by a prefix in the user name (e.g. the user name "namespace1~user1" indicates that the user is in "namespace1").
Users in a namespace can only be administrated by users in the "Administrator" role in that same namespace.
System\-wide users can only be administratred by system\-wide users in the "Administrator" role.
.SH OPTIONS
.TP
\fB\-a\fR, \fB\-\-auth\-passphrase\-file\fR \fI<AUTH_PASSPHRASE_FILE>\fR
The path to a file containing a passphrase for authentication

The passphrase provided in the file must be the one for the user chosen for the command.

This option can be provided multiple times, which is needed for commands that require multiple roles at once.
With multiple passphrase files ordering matters, as the files are assigned to the respective user provided by the "\-\-user" option.
.RS
May also be specified with the \fBNETHSM_AUTH_PASSPHRASE_FILE\fR environment variable. 
.RE
.TP
\fB\-c\fR, \fB\-\-config\fR \fI<CONFIG>\fR
The path to a custom configuration file

If specified, the custom configuration file is used instead of the default configuration file location.
.RS
May also be specified with the \fBNETHSM_CONFIG\fR environment variable. 
.RE
.TP
\fB\-l\fR, \fB\-\-label\fR \fI<LABEL>\fR
A label uniquely identifying a device in the configuration file

Must be provided if more than one device is setup in the configuration file.
.RS
May also be specified with the \fBNETHSM_LABEL\fR environment variable. 
.RE
.TP
\fB\-u\fR, \fB\-\-user\fR \fI<USER>\fR
A user name which is used for a command

Can be provided, if no user name is setup in the configuration file for a device.
Must be provided, if several user names of the same target role are setup in the configuration file for a device.

This option can be provided multiple times, which is needed for commands that require multiple roles at once.

.RS
May also be specified with the \fBNETHSM_USER\fR environment variable. 
.RE
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help (see a summary with \*(Aq\-h\*(Aq)
.SH SUBCOMMANDS
.TP
nethsm\-user\-add(1)
Add a user
.TP
nethsm\-user\-get(1)
Get information about a user
.TP
nethsm\-user\-list(1)
List all user names
.TP
nethsm\-user\-passphrase(1)
Set the passphrase for a user
.TP
nethsm\-user\-remove(1)
Remove a user
.TP
nethsm\-user\-tag(1)
Add a tag to a user
.TP
nethsm\-user\-untag(1)
Remove a tag from a user
.TP
nethsm\-user\-help(1)
Print this message or the help of the given subcommand(s)