.nh
.TH pki-user-membership 1 "Aug 24, 2015" PKI "PKI User Membership Management Commands"
.SH NAME
.PP
pki-user-membership - Command-line interface for managing PKI user memberships.

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

.SH DESCRIPTION
.PP
The \fBpki <subsystem>-user-membership\fP commands provide command-line interfaces to manage user memberships 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-membership\fP
.br
    This command is to list available user membership commands for the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-user-membership-find\fP \fIuser-ID\fP [\fIcommand-options\fP]
.br
    This command is to list groups in which the subsystem user is a member.

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

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

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

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

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

.PP
For example, to list groups in which a CA user is a member execute the following command:

.PP
.RS

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

.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-membership-find testuser --start 20 --size 10

.fi
.RE

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

.PP
To add a CA user into a group, specify the user ID and the group ID in the following command:

.PP
.RS

.nf
$ pki <CA admin authentication> ca-user-membership-add testuser Administrators

.fi
.RE

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

.PP
.RS

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

.fi
.RE

.SH AUTHORS
.PP
Endi S. Dewata &lt;edewata@redhat.com&gt;\&.

.SH COPYRIGHT
.PP
Copyright (c) 2015 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.