Skip to content

Commit 28c3b3f

Browse files
(DOCSP-12723): add --name and --includeDeleted options to iam commands (#342)
* (DOCSP-12723): add --name and --includeDeleted options to iam commands * (DOCSP-12723): fix typo * (DOCSP-12723): copy review feedback
1 parent fae4a49 commit 28c3b3f

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

source/reference/iam/iam-organization-create.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ information on these fields, see
142142

143143
{
144144
"id": "abcdefghi123456789",
145+
"isDeleted": false,
145146
"links": [
146147
{
147148
"rel": "self",

source/reference/iam/iam-organization-describe.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ The command returns the following |json| document:
142142

143143
{
144144
"id": "5b07759a08372616070df448",
145+
"isDeleted": false,
145146
"links": [
146147
{
147148
"rel": "self",
@@ -182,6 +183,7 @@ The command returns the following |json| document:
182183

183184
{
184185
"id": "5b07759a08372616070df448",
186+
"isDeleted": false,
185187
"links": [
186188
{
187189
"rel": "self",

source/reference/iam/iam-organization-list.txt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ Syntax
3737
.. code-block:: text
3838

3939
mongocli iam organization|organizations|org|orgs list|ls
40+
[ --includeDeleted ]
4041
[ --limit <number-of-orgs> ]
42+
[ --name <org-name> ]
4143
[ --output|-o <output-format> ]
4244
[ --page <number-of-pages> ]
4345
[ --profile|-P <profile-name> ]
@@ -58,6 +60,24 @@ Options
5860
- Description
5961
- Required?
6062

63+
* - ``--includeDeleted``
64+
-
65+
- Flag that indicates whether {+mcli+} returns deleted
66+
organizations.
67+
68+
.. important::
69+
70+
This flag:
71+
72+
- is applicable for |onprem| organizations only. {+mcli+}
73+
never returns deleted |service| or |cloud-short|
74+
organizations.
75+
- requires you to have an |onprem| :opsmgr:`global role
76+
</reference/user-roles/#global-roles>`.
77+
78+
If omitted, {+mcli+} doesn't return deleted organizations.
79+
- no
80+
6181
* - ``--limit``
6282
- integer
6383
- Number of organizations to return per page.
@@ -70,6 +90,19 @@ Options
7090
For example usage, see :ref:`mcli-organization-list-examples-pagination`.
7191
- no
7292

93+
* - ``--name``
94+
- string
95+
- Filter that {+mcli+} uses to limit results based on the specified
96+
organization name. Performs a case-insensitive search for
97+
organizations that exactly match the specified ``name``.
98+
99+
.. example::
100+
101+
If you specify a ``--name`` option of org1, {+mcli+} returns
102+
organizations named ``org1`` and ``Org1``, but would not
103+
return an organization named ``org123``.
104+
- no
105+
73106
* - ``--output``, ``-o``
74107
- string
75108
- .. include:: /includes/extracts/fact-basic-options-output.rst
@@ -186,6 +219,7 @@ The command returns the following |json| document:
186219
"results": [
187220
{
188221
"id": "abcdef3e1234de007b387a9f",
222+
"isDeleted": false,
189223
"links": [
190224
{
191225
"rel": "self",
@@ -225,6 +259,7 @@ The command returns the following |json| document:
225259
"results": [
226260
{
227261
"id": "5e332f3e1234de007b387a9f",
262+
"isDeleted": false,
228263
"links": [
229264
{
230265
"rel": "self",
@@ -235,6 +270,7 @@ The command returns the following |json| document:
235270
},
236271
{
237272
"id": "5e38efd83b60f567896baf4d",
273+
"isDeleted": false,
238274
"links": [
239275
{
240276
"rel": "self",
@@ -279,6 +315,7 @@ the terminal. To learn more about these fields, see
279315
"results": [
280316
{
281317
"id": "5e332f3e1234de007b387a9f",
318+
"isDeleted": false,
282319
"links": [
283320
{
284321
"rel": "self",
@@ -289,6 +326,7 @@ the terminal. To learn more about these fields, see
289326
},
290327
{
291328
"id": "5e38efd83b60f567896baf4d",
329+
"isDeleted": false,
292330
"links": [
293331
{
294332
"rel": "self",
@@ -299,6 +337,7 @@ the terminal. To learn more about these fields, see
299337
},
300338
{
301339
"id": "27a91237ba9cb28a15ed3f51",
340+
"isDeleted": false,
302341
"links": [
303342
{
304343
"rel": "self",
@@ -309,6 +348,7 @@ the terminal. To learn more about these fields, see
309348
},
310349
{
311350
"id": "959bd41f6c65d5a31077f78a",
351+
"isDeleted": false,
312352
"links": [
313353
{
314354
"rel": "self",
@@ -319,6 +359,7 @@ the terminal. To learn more about these fields, see
319359
},
320360
{
321361
"id": "f459b51a9a6e4eba907b47ad",
362+
"isDeleted": false,
322363
"links": [
323364
{
324365
"rel": "self",

0 commit comments

Comments
 (0)