.nh
.TH pki-user 1 "May 5, 2014" PKI "PKI User Management Commands"
.SH NAME
.PP
pki-user - Command-line interface for managing PKI users.

.SH SYNOPSIS
.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user\fP
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-find\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-show\fP \fIuser-ID\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-add\fP \fIuser-ID\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-mod\fP \fIuser-ID\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-del\fP \fIuser-ID\fP [\fIcommand-options\fP]

.SH DESCRIPTION
.PP
The \fBpki <subsystem>-user\fP commands provide command-line interfaces to manage users on the specified subsystem.

.PP
Valid subsystems are \fBca\fP, \fBkra\fP, \fBocsp\fP, \fBtks\fP, and \fBtps\fP\&.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user\fP
.br
    This command is to list available user commands for the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-find\fP [\fIcommand-options\fP]
.br
    This command is to list users in the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-show\fP \fIuser-ID\fP [\fIcommand-options\fP]
.br
    This command is to view a user details in the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-add\fP \fIuser-ID\fP [\fIcommand-options\fP]
.br
    This command is to add a user into the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-mod\fP \fIuser-ID\fP [\fIcommand-options\fP]
.br
    This command is to modify a user in the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-del\fP \fIuser-ID\fP [\fIcommand-options\fP]
.br
    This command is to delete a user from the subsystem.

.SH OPTIONS
.PP
The CLI options are described in \fBpki(1)\fP\&.

.SH OPERATIONS
.PP
To view available user commands, type \fBpki <subsystem>-user\fP\&.
To view each command's usage, type \fBpki <subsystem>-user-<command> --help\fP\&.

.PP
All user commands must be executed as the subsystem administrator.

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

.PP
.RS

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

.fi
.RE

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

.PP
.RS

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

.fi
.RE

.PP
The above command will return entries #20 to #29.

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

.PP
.RS

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

.fi
.RE

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

.PP
.RS

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

.fi
.RE

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

.PP
.RS

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

.fi
.RE

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

.PP
.RS

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

.fi
.RE

.SH SEE ALSO
.PP
\fBpki-user-cert(1)\fP
.br
    User certificate management commands

.SH AUTHORS
.PP
Ade Lee &lt;alee@redhat.com&gt;, Endi Dewata &lt;edewata@redhat.com&gt;, and Matthew Harmsen &lt;mharmsen@redhat.com&gt;\&.

.SH COPYRIGHT
.PP
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.