nethsm-key-tag(1)           General Commands Manual          nethsm-key-tag(1)

NAME
       nethsm-key-tag - Tag a key

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

DESCRIPTION
       Tag a key

       Tags are used to grant access to keys for users in the "Operator" role.
       If a user and a key are tagged with the same tag, the user gains access
       to that key.  As keys exist either system-wide or in a namespace, users
       in the "Operator" role must be in the same scope as the key for this
       have effect!

       Note: Tags on keys must be created before creating tags on users.

       System-wide users in the "Administrator" role can only tag system-wide
       keys.  Namespaced users in the "Administrator" role can only tag keys
       in their own namespace.

       Requires authentication of a user 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')

       <KEY_ID>
              The ID of the key for which a tag is added
              May also be specified with the NETHSM_KEY_ID environment
              variable.

       <TAG>  The tag to add to the key
              May also be specified with the NETHSM_KEY_TAG environment
              variable.

                                nethsm-key-tag               nethsm-key-tag(1)