DOCSP-12038 doc for mongocli iam user(s) describe command (#246)

* DOCSP-12038 doc for mongocli iam user(s) describe command

* DOCSP-12038 updates for copy review feedback

Author: kanchana-mongodb

source/reference/access.txt

@@ -33,6 +33,9 @@
 :ref:`team <mcli-reference-iam-team>`
   Manage teams in your project.
 
+:ref:`User <mcli-reference-iam-user>`
+  Manage users in your project.
+
 .. class:: hidden
 
    .. toctree::

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

@@ -0,0 +1,171 @@
+.. _iam-user-describe:
+
+==========================
+mongocli iam user describe
+==========================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+The ``mongocli iam user describe`` command retrieves information about a
+user specified by username or ID. You can also retrieve details about a 
+user using the |api| for your MongoDB service: 
+
+- |service| :atlas:`Get a User by ID API </reference/api/user-get-by-id/>` and 
+  :atlas:`Get a User by Name API </reference/api/user-get-one-by-name/>`
+- |cloud-short| :cloudmgr:`Get a User by ID API 
+  </reference/api/user-get-by-id/>` and :cloudmgr:`Get a User by Name API 
+  </reference/api/user-get-by-name/>`
+- |onprem| :opsmgr:`Get a User by ID API </reference/api/user-get-by-id/>` and 
+  :opsmgr:`Get a User by Name API </reference/api/user-get-by-name/>`
+
+.. _mcli-iam-user-describe-syntax:
+
+Syntax 
+------
+
+.. code-block:: text 
+
+   mongocli iam user describe
+        --id <user-id>
+        [ --output|-o <output-format> ]
+        [ --profile|-P <profile-name> ]
+        --username <username-of-user>
+
+.. include:: /includes/fact-command-line-help.rst
+
+.. _mcli-iam-user-describe-options:
+
+Options 
+-------
+
+.. list-table:: 
+   :header-rows: 1
+   :widths: 20 10 60 10
+
+   * - Option 
+     - Type 
+     - Description 
+     - Required? 
+
+   * - ``--id`` 
+     - string 
+     - Unique identifier of the user. Either ``id`` or ``username`` 
+       is required.
+     - conditional
+
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
+   * - ``--profile``, ``-P`` 
+     - string 
+     - Name of the profile that contains the access information. If
+       omitted, uses the {+default-profile+}. 
+     - no 
+
+   * - ``--username`` 
+     - string 
+     - Username of the user. Either ``username`` or ``id`` is 
+       required.
+     - conditional
+
+.. _mcli-iam-user-describe-output:
+
+Output 
+------
+
+The command prints the following output to the terminal if the command 
+succeeds. If the command returns errors, see :ref:`Troubleshooting 
+<troubleshooting>` for recommended solutions.
+
+.. code-block:: none
+
+   ID            FIRST NAME    LAST NAME    USERNAME    EMAIL
+   <user-email>  <first-name>  <last-name>  <username>  <email-address>
+
+The above default output is a subset of the fields returned by this command. 
+For the complete list of |json| fields returned by the command, see the API 
+reference for your MongoDB service:
+
+- |service| :atlas:`Get a User by ID API Response 
+  </reference/api/user-get-by-id/#response>` and :atlas:`Get a User by Name 
+  API Response </reference/api/user-get-one-by-name/#response>`
+- |cloud-short| :cloudmgr:`Get a User by ID API Response 
+  </reference/api/user-get-by-id/#response>` and :cloudmgr:`Get a User by Name 
+  API Response </reference/api/user-get-by-name/#response>`
+- |onprem| :opsmgr:`Get a User by ID API Response 
+  </reference/api/user-get-by-id/#response>` and :opsmgr:`Get a User by Name 
+  API Response </reference/api/user-get-by-name/#response>`
+
+.. _mcli-iam-user-describe-examples:
+
+Example
+-------
+
+.. tabs::
+
+   .. tab:: Default Output
+      :tabid: default
+
+      The following command returns information in the default format about a 
+      user whose ID is ``5dd56c847a3e5a1f363d424d`` in a |cloud-short| 
+      organization. It uses the {+default-profile+} for accessing 
+      |cloud-short|. 
+
+      .. code-block:: text 
+
+         mongocli iam user describe --id 5dd56c847a3e5a1f363d424d
+
+      The previous command prints the following to the terminal: 
+
+      .. code-block:: text 
+         :copyable: false
+
+         ID                         FIRST NAME   LAST NAME   USERNAME                  EMAIL
+         5dd56c847a3e5a1f363d424d   John         Doe         [email protected]      [email protected]
+
+   .. tab:: JSON Output
+      :tabid: json
+
+      The following command returns information in |json| format about a 
+      user whose username is ``[email protected]`` in an |service| 
+      organization. It uses the {+default-profile+} for accessing |service|. 
+
+      .. code-block:: text 
+
+         mongocli iam user describe --username "[email protected]" -o json 
+
+      The previous command prints the following in the specified format to 
+      the terminal. For more information on these fields, see 
+      :ref:`Output <mcli-iam-user-describe-output>`.
+
+      .. code-block:: json 
+         :copyable: false 
+
+         {
+           "emailAddress": "[email protected]",
+           "firstName": "John",
+           "id": "5dd56c847a3e5a1f363d424d",
+           "lastName": "Doe",
+           "roles": [
+             {
+               "groupId": "5f455b39749bea5fb575dccc",
+               "roleName": "GROUP_OWNER"
+             },
+             {
+               "orgId": "5e2f05fef10fab66c7d408b3",
+               "roleName": "ORG_OWNER"
+             }
+           ],
+           "username": "[email protected]",
+           "mobileNumber": "",
+           "password": "",
+           "country": "US"
+         }

source/reference/iam/user-commands.txt

@@ -16,3 +16,4 @@ User Commands
    :titlesonly:
 
    Create One User <iam-user-invite>
+   Describe a User <iam-user-describe>