Skip to content

Commit ebe33b4

Browse files
DOCSP-12042 doc for iam users delete command (#247)
* DOCSP-12042 doc for iam users delete command * DOCSP-12041 fixes per feedback
1 parent 55152ee commit ebe33b4

File tree

4 files changed

+110
-3
lines changed

4 files changed

+110
-3
lines changed

source/reference/access.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
Manage teams in your project.
3535

3636
:ref:`User <mcli-reference-iam-user>`
37-
Manage users in your project.
37+
Manage users in your MongoDB service.
3838

3939
.. class:: hidden
4040

source/reference/iam/iam-team-user-delete.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Options
8585
omitted, uses the {+default-profile+}.
8686
- no
8787

88-
.. _mcli-iam-team-delete-user-output:
88+
.. _mcli-iam-team-user-delete-output:
8989

9090
Output
9191
------
@@ -98,7 +98,7 @@ for recommended solutions.
9898

9999
User '<user-ID>' deleted from the team
100100

101-
.. _mcli-iam-user-delete-examples:
101+
.. _mcli-iam-team-user-delete-examples:
102102

103103
Example
104104
-------
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
.. _iam-user-delete:
2+
3+
=========================
4+
mongocli iam users delete
5+
=========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
The ``mongocli iam users delete`` command deletes an |onprem| user
16+
with the specified user ID. You can also delete a user from |onprem|
17+
using the :opsmgr:`API </reference/api/users/delete-one-user/>`.
18+
19+
.. _mcli-iam-user-delete-syntax:
20+
21+
Syntax
22+
------
23+
24+
.. code-block:: text
25+
26+
mongocli iam users delete|rm <user-id>
27+
[ --force ]
28+
[ --profile|-P <profile-name> ]
29+
30+
.. include:: /includes/fact-command-line-help.rst
31+
32+
Arguments
33+
---------
34+
35+
.. list-table::
36+
:header-rows: 1
37+
:widths: 20 10 60 10
38+
39+
* - Argument
40+
- Type
41+
- Description
42+
- Required?
43+
44+
* - ``<user-id>``
45+
- string
46+
- Unique identifier of the user you want to delete.
47+
- yes
48+
49+
.. _mcli-iam-user-delete-options:
50+
51+
Options
52+
-------
53+
54+
.. list-table::
55+
:header-rows: 1
56+
:widths: 20 10 60 10
57+
58+
* - Option
59+
- Type
60+
- Description
61+
- Required?
62+
63+
* - ``--force``
64+
-
65+
- Flag that indicates that the user can be deleted without
66+
requiring confirmation.
67+
- no
68+
69+
* - ``--profile``, ``-P``
70+
- string
71+
- Name of the profile that contains the access information. If
72+
omitted, uses the {+default-profile+}.
73+
- no
74+
75+
.. _mcli-iam-user-delete-output:
76+
77+
Output
78+
------
79+
80+
The command prints following output to the terminal if the command succeeds.
81+
If the command returns errors, see :ref:`Troubleshooting <troubleshooting>`
82+
for recommended solutions.
83+
84+
.. code-block:: none
85+
86+
User '<user-id>' deleted
87+
88+
.. _mcli-iam-user-delete-examples:
89+
90+
Example
91+
-------
92+
93+
The following command deletes a user with ID ``5e44445ef10fab20b49c0f31``
94+
in an |onprem| organization. It uses the {+default-profile+} for accessing
95+
|onprem|.
96+
97+
.. code-block:: text
98+
99+
mongocli iam user delete 5e44445ef10fab20b49c0f31 --force
100+
101+
The previous command prints the following to the terminal.
102+
103+
.. code-block:: none
104+
:copyable: false
105+
106+
User '5e44445ef10fab20b49c0f31' deleted

source/reference/iam/user-commands.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ User Commands
1717

1818
Create One User <iam-user-invite>
1919
Describe a User <iam-user-describe>
20+
Delete One Ops Manager User <iam-user-delete>

0 commit comments

Comments
 (0)