1pki-user(1) PKI User Management Commands pki-user(1)
2
3
4
6 pki-user - Command-Line Interface for managing Certificate System
7 users.
8
9
11 pki [CLI options] <subsystem>-user
12 pki [CLI options] <subsystem>-user-find [command options]
13 pki [CLI options] <subsystem>-user-show <user ID> [command options]
14 pki [CLI options] <subsystem>-user-add <user ID> [command options]
15 pki [CLI options] <subsystem>-user-mod <user ID> [command options]
16 pki [CLI options] <subsystem>-user-del <user ID> [command options]
17
18
20 The pki-user commands provide command-line interfaces to manage users
21 on the specified subsystem.
22
23 Valid subsystems are ca, kra, ocsp, tks, and tps. If the <subsystem>-
24 prefix is omitted, it will default to ca.
25
26 pki [CLI options] <subsystem>-user
27 This command is to list available user commands for the subsystem.
28
29 pki [CLI options] <subsystem>-user-find [command options]
30 This command is to list users in the subsystem.
31
32 pki [CLI options] <subsystem>-user-show <user ID> [command options]
33 This command is to view a user details in the subsystem.
34
35 pki [CLI options] <subsystem>-user-add <user ID> [command options]
36 This command is to add a user into the subsystem.
37
38 pki [CLI options] <subsystem>-user-mod <user ID> [command options]
39 This command is to modify a user in the subsystem.
40
41 pki [CLI options] <subsystem>-user-del <user ID> [command options]
42 This command is to delete a user from the subsystem.
43
44
46 The CLI options are described in pki(1).
47
48
50 To view available user commands, type pki <subsystem>-user. To view
51 each command's usage, type pki <subsystem>-user-<command> --help.
52
53 All user commands must be executed as the subsystem administrator.
54
55 For example, to list users in CA execute the following command:
56
57 pki <CA admin authentication> ca-user-find
58
59 The results can be paged by specifying the (0-based) index of the first
60 entry to return and the maximum number of entries returned:
61
62 pki <CA admin authentication> ca-user-find --start 20 --size 10
63
64 The above command will return entries #20 to #29.
65
66 To view the details of a CA user, specify the user ID in the following
67 command:
68
69 pki <CA admin authentication> ca-user-show testuser
70
71 To add a new CA user, specify the user ID and at least the full name in
72 the following command:
73
74 pki <CA admin authentication> ca-user-add testuser --fullName “Test
75 User”
76
77 To modify a CA user, specify the user ID and the attributes to be
78 changed in the following command:
79
80 pki <CA admin authentication> ca-user-mod testuser --email tes‐
81 tuser@example.com --phone 123-456-7890
82
83 To delete a CA user, specify the user ID in the following command:
84
85 pki <CA admin authentication> ca-user-del testuser
86
87
89 pki-user-cert(1)
90 User certificate management commands
91
92
94 Ade Lee <alee@redhat.com>, Endi Dewata <edewata@redhat.com>, and
95 Matthew Harmsen <mharmsen@redhat.com>.
96
97
99 Copyright (c) 2014 Red Hat, Inc. This is licensed under the GNU General
100 Public License, version 2 (GPLv2). A copy of this license is available
101 at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
102
103
104
105version 10.2 May 5, 2014 pki-user(1)