nethsm-user(1)              General Commands Manual             nethsm-user(1)

NAME
       nethsm-user - Operate on users of a device

SYNOPSIS
       nethsm user [-a|--auth-passphrase-file] [-c|--config] [-l|--label]
       [-u|--user] [-h|--help] <subcommands>

DESCRIPTION
       Operate on users of a device

       Allows to add and remove users, retrieve information about them, set
       their passphrases and set or unset tags for them.

       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.

OPTIONS
       -a, --auth-passphrase-file <AUTH_PASSPHRASE_FILE>
              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.
              May also be specified with the NETHSM_AUTH_PASSPHRASE_FILE
              environment variable.

       -c, --config <CONFIG>
              The path to a custom configuration file

              If specified, the custom configuration file is used instead of
              the default configuration file location.
              May also be specified with the NETHSM_CONFIG environment
              variable.

       -l, --label <LABEL>
              A label uniquely identifying a device in the configuration file

              Must be provided if more than one device is setup in the
              configuration file.
              May also be specified with the NETHSM_LABEL environment
              variable.

       -u, --user <USER>
              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.

              May also be specified with the NETHSM_USER environment variable.

       -h, --help
              Print help (see a summary with '-h')

SUBCOMMANDS
       nethsm-user-add(1)
              Add a user

       nethsm-user-get(1)
              Get information about a user

       nethsm-user-list(1)
              List all user names

       nethsm-user-passphrase(1)
              Set the passphrase for a user

       nethsm-user-remove(1)
              Remove a user

       nethsm-user-tag(1)
              Add a tag to a user

       nethsm-user-untag(1)
              Remove a tag from a user

       nethsm-user-help(1)
              Print this message or the help of the given subcommand(s)

                                 nethsm-user                    nethsm-user(1)