pki-user(1)

1pki-user(1)              PKI User Management Commands              pki-user(1)
2
3
4

NAME

6       pki-user - Command-line interface for managing PKI users.
7
8

SYNOPSIS

10       pki [CLI-options] lt;subsystemgt;-user
11       pki [CLI-options] lt;subsystemgt;-user-find [command-options]
12       pki [CLI-options] lt;subsystemgt;-user-show user-ID [command-options]
13       pki [CLI-options] lt;subsystemgt;-user-add user-ID [command-options]
14       pki [CLI-options] lt;subsystemgt;-user-mod user-ID [command-options]
15       pki [CLI-options] lt;subsystemgt;-user-del user-ID [command-options]
16
17

DESCRIPTION

19       The  pki  lt;subsystemgt;-user commands provide command-line interfaces
20       to manage users on the specified subsystem.
21
22
23       Valid subsystems are ca, kra, ocsp, tks, and tps.
24
25
26       pki [CLI-options] lt;subsystemgt;-user
27           This command is to list available user commands for the subsystem.
28
29
30       pki [CLI-options] lt;subsystemgt;-user-find [command-options]
31           This command is to list users in the subsystem.
32
33
34       pki [CLI-options] lt;subsystemgt;-user-show user-ID [command-options]
35           This command is to view a user details in the subsystem.
36
37
38       pki [CLI-options] lt;subsystemgt;-user-add user-ID [command-options]
39           This command is to add a user into the subsystem.
40
41
42       pki [CLI-options] lt;subsystemgt;-user-mod user-ID [command-options]
43           This command is to modify a user in the subsystem.
44
45
46       pki [CLI-options] lt;subsystemgt;-user-del user-ID [command-options]
47           This command is to delete a user from the subsystem.
48
49

OPTIONS

51       The CLI options are described in pki(1).
52
53

OPERATIONS

55       To view available user commands,  type  pki  lt;subsystemgt;-user.   To
56       view  each command's usage, type pki lt;subsystemgt;-user-lt;commandgt;
57       --help.
58
59
60       All user commands must be executed as the subsystem administrator.
61
62
63       For example, to list users in CA execute the following command:
64
65
66              $ pki <CA admin authentication> ca-user-find
67
68
69
70       The results can be paged by specifying the (0-based) index of the first
71       entry to return and the maximum number of entries returned:
72
73
74              $ pki <CA admin authentication> ca-user-find --start 20 --size 10
75
76
77
78       The above command will return entries #20 to #29.
79
80
81       To  view the details of a CA user, specify the user ID in the following
82       command:
83
84
85              $ pki <CA admin authentication> ca-user-show testuser
86
87
88
89       To add a new CA user, specify the user ID and at least the full name in
90       the following command:
91
92
93              $ pki <CA admin authentication> ca-user-add testuser --fullName "Test User"
94
95
96
97       To  modify  a  CA  user,  specify  the user ID and the attributes to be
98       changed in the following command:
99
100
101              $ pki <CA admin authentication> ca-user-mod testuser \
102                  --email testuser@example.com --phone 123-456-7890
103
104
105
106       To delete a CA user, specify the user ID in the following command:
107
108
109              $ pki <CA admin authentication> ca-user-del testuser
110
111
112

AUTHORS

119       Ade Lee lt;alee@redhat.comgt;,  Endi  Dewata  lt;edewata@redhat.comgt;,
120       and Matthew Harmsen lt;mharmsen@redhat.comgt;.
121
122

COPYRIGHT

124       Copyright  (c)  2014 Red Hat, Inc.  This is licensed under the GNU Gen‐
125       eral Public License, version 2 (GPLv2).  A  copy  of  this  license  is
126       available at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
127
128
129
130PKI                               May 5, 2014                      pki-user(1)