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] <subsystem>-user
11       pki [CLI-options] <subsystem>-user-find [command-options]
12       pki [CLI-options] <subsystem>-user-show user-ID [command-options]
13       pki [CLI-options] <subsystem>-user-add user-ID [command-options]
14       pki [CLI-options] <subsystem>-user-mod user-ID [command-options]
15       pki [CLI-options] <subsystem>-user-del user-ID [command-options]
16
17

DESCRIPTION

19       The  pki  <subsystem>-user  commands provide command-line interfaces to
20       manage users on the specified subsystem.
21
22
23       Valid subsystems are ca, kra, ocsp, tks, and tps.
24
25
26       pki [CLI-options] <subsystem>-user
27           This command is to list available user commands for the subsystem.
28
29
30       pki [CLI-options] <subsystem>-user-find [command-options]
31           This command is to list users in the subsystem.
32
33
34       pki [CLI-options] <subsystem>-user-show user-ID [command-options]
35           This command is to view a user details in the subsystem.
36
37
38       pki [CLI-options] <subsystem>-user-add user-ID [command-options]
39           This command is to add a user into the subsystem.
40
41
42       pki [CLI-options] <subsystem>-user-mod user-ID [command-options]
43           This command is to modify a user in the subsystem.
44
45
46       pki [CLI-options] <subsystem>-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  <subsystem>-user.   To  view
56       each command's usage, type pki <subsystem>-user-<command> --help.
57
58
59       All user commands must be executed as the subsystem administrator.
60
61
62       For example, to list users in CA execute the following command:
63
64
65              $ pki <CA admin authentication> ca-user-find
66
67
68
69       The results can be paged by specifying the (0-based) index of the first
70       entry to return and the maximum number of entries returned:
71
72
73              $ pki <CA admin authentication> ca-user-find --start 20 --size 10
74
75
76
77       The above command will return entries #20 to #29.
78
79
80       To view the details of a CA user, specify the user ID in the  following
81       command:
82
83
84              $ pki <CA admin authentication> ca-user-show testuser
85
86
87
88       To add a new CA user, specify the user ID and at least the full name in
89       the following command:
90
91
92              $ pki <CA admin authentication> ca-user-add testuser --fullName "Test User"
93
94
95
96       To modify a CA user, specify the user  ID  and  the  attributes  to  be
97       changed in the following command:
98
99
100              $ pki <CA admin authentication> ca-user-mod testuser \
101                  --email testuser@example.com --phone 123-456-7890
102
103
104
105       To delete a CA user, specify the user ID in the following command:
106
107
108              $ pki <CA admin authentication> ca-user-del testuser
109
110
111

AUTHORS

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

COPYRIGHT

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