pki-user(1)

💖 pki-user(1) — PKI User Management Commands 💖

Okay bestie, this is the manual page for pki-user, aka the command-line interface for managing PKI users. It’s giving “admin main character energy,” and honestly? We’re obsessed. 🫶

✨ NAME ✨

pki-user — Command-line interface for managing PKI users.

🌸 SYNOPSIS 🌸

pki [CLI-options] <subsystem>-user
pki [CLI-options] <subsystem>-user-find [command-options]
pki [CLI-options] <subsystem>-user-show user-ID [command-options]
pki [CLI-options] <subsystem>-user-add user-ID [command-options]
pki [CLI-options] <subsystem>-user-mod user-ID [command-options]
pki [CLI-options] <subsystem>-user-del user-ID [command-options]

🦋 DESCRIPTION 🦋

The pki <subsystem>-user commands give you command-line interfaces to manage users on the specified subsystem. Lowkey iconic. ✨

Valid subsystems are ca, kra, ocsp, tks, and tps.

• pki [CLI-options] <subsystem>-user — This one lists the available user commands for the subsystem.
• pki [CLI-options] <subsystem>-user-find [command-options] — This one lists users in the subsystem.
• pki [CLI-options] <subsystem>-user-show user-ID [command-options] — This one views a user’s details in the subsystem.
• pki [CLI-options] <subsystem>-user-add user-ID [command-options] — This one adds a user into the subsystem.
• pki [CLI-options] <subsystem>-user-mod user-ID [command-options] — This one modifies a user in the subsystem.
• pki [CLI-options] <subsystem>-user-del user-ID [command-options] — This one deletes a user from the subsystem.

👑 OPTIONS 👑

The CLI options are described in pki(1). Go read that one too, bestie — it’s the main character of CLI options. 💅

🌈 OPERATIONS 🌈

To view the available user commands, type pki <subsystem>-user. To view each command’s usage, type pki <subsystem>-user-<command> --help.

🚨 Bestie, listen: all user commands must be executed as the subsystem administrator. No cap.

For example, to list users in CA, execute the following command:

$ pki <CA admin authentication> ca-user-find

The results can be paged by specifying the (0-based) index of the first entry to return and the maximum number of entries returned:

$ pki <CA admin authentication> ca-user-find --start 20 --size 10

The above command will return entries #20 to #29. Periodt. 💅

To view the details of a CA user, specify the user ID in the following command:

$ pki <CA admin authentication> ca-user-show testuser

To add a new CA user, specify the user ID and at least the full name in the following command:

$ pki <CA admin authentication> ca-user-add testuser --fullName "Test User"

To modify a CA user, specify the user ID and the attributes to be changed in the following command:

$ pki <CA admin authentication> ca-user-mod testuser \
    --email testuser@example.com --phone 123-456-7890

To delete a CA user, specify the user ID in the following command:

$ pki <CA admin authentication> ca-user-del testuser

🎀 SEE ALSO 🎀

• pki-user-cert(1) — User certificate management commands

🧚 AUTHORS 🧚

Ade Lee <alee@redhat.com>, Endi Dewata <edewata@redhat.com>, and Matthew Harmsen <mharmsen@redhat.com>.

💜 COPYRIGHT 💜

Copyright (c) 2014 Red Hat, Inc. This is licensed under the GNU General Public License, version 2 (GPLv2). A copy of this license is available at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.

---

💌 Signed, sealed, delivered: this iconic manual page comes from PKI, dated May 5, 2014, and it’s literally pki-user(1). Mwah. 💋