pki-user - Man Page

Command-line interface for managing PKI users.

Synopsis

pki [CLI-options] lt;subsystemgt;-user
pki [CLI-options] lt;subsystemgt;-user-find [command-options]
pki [CLI-options] lt;subsystemgt;-user-show user-ID [command-options]
pki [CLI-options] lt;subsystemgt;-user-add user-ID [command-options]
pki [CLI-options] lt;subsystemgt;-user-mod user-ID [command-options]
pki [CLI-options] lt;subsystemgt;-user-del user-ID [command-options]

Description

The pki lt;subsystemgt;-user commands provide command-line interfaces to manage users on the specified subsystem.

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

pki [CLI-options] lt;subsystemgt;-user
   This command is to list available user commands for the subsystem.

pki [CLI-options] lt;subsystemgt;-user-find [command-options]
   This command is to list users in the subsystem.

pki [CLI-options] lt;subsystemgt;-user-show user-ID [command-options]
   This command is to view a user details in the subsystem.

pki [CLI-options] lt;subsystemgt;-user-add user-ID [command-options]
   This command is to add a user into the subsystem.

pki [CLI-options] lt;subsystemgt;-user-mod user-ID [command-options]
   This command is to modify a user in the subsystem.

pki [CLI-options] lt;subsystemgt;-user-del user-ID [command-options]
   This command is to delete a user from the subsystem.

Options

The CLI options are described in pki(1).

Operations

To view available user commands, type pki lt;subsystemgt;-user. To view each command's usage, type pki lt;subsystemgt;-user-lt;commandgt; --help.

All user commands must be executed as the subsystem administrator.

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.

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 lt;alee@redhat.comgt;, Endi Dewata lt;edewata@redhat.comgt;, and Matthew Harmsen lt;mharmsen@redhat.comgt;.

Referenced By

pki(1).

May 5, 2014 PKI User Management Commands