(DOCSP-11538) mongocli iam project apikey create|list|assign|delete (#202)

(DOCSP-11538) iam project apikey create|list|assign|delete

Author: zach-carr

source/reference/access.txt

@@ -21,6 +21,9 @@
 :ref:`project <mcli-reference-iam-project>`
   Manage projects in your |service|, |com| instance.
 
+:ref:`project apikey <mcli-reference-iam-project-apikeys>`
+  Manage |api| keys in your project.
+
 .. class:: hidden
 
    .. toctree::
@@ -29,3 +32,4 @@
       Organizations </reference/iam/organization-commands>
       Organization API Keys </reference/iam/organization-apikey-commands>
       Projects </reference/iam/project-commands>
+      Project API Keys </reference/iam/project-apikey-commands>

source/reference/iam/iam-organization-apikey-assign.txt

@@ -22,7 +22,7 @@ Syntax
 
 .. code-block:: text 
 
-   mongocli iam organization|organizations|org|orgs apiKey|apiKeys|apikeys assign|updates <api-key-id>
+   mongocli iam organization|organizations|org|orgs apiKey|apiKeys|apikeys assign|update <api-key-id>
         [ --desc "<description-of-key>" ]
         [ --orgId <organization-id> ]
         [ --output|-o <output-format> ]

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

@@ -158,7 +158,7 @@ Examples
 
       .. code-block:: sh
 
-         mongocli iam organization apikey create --desc "My API key" --orgId 5a1b39eec902201990f12345 --role ORG_OWNER,ORG_MEMBER --output json
+         mongocli iam organization apikey create --desc "My API key" --orgId 5a1b39eec902201990f12345 --role ORG_OWNER,ORG_MEMBER --profile myOM --output json
 
       The previous command creates the |api| key and 
       prints the following to the terminal in |json| format.

source/reference/iam/iam-organization-apikey-delete.txt

@@ -142,13 +142,13 @@ Examples
       :tabid: json-output
 
       The following command deletes an organization |api| key without
-      confirmation. The command uses the ``myOM`` profile, which contains
-      credentials, and returns the output in |json| format.
+      confirmation. The command uses the ``myOM`` profile, which 
+      contains credentials and specifies the |onprem| service, and 
+      returns the output in |json| format.
 
       .. code-block:: sh
 
-         mongocli iam org apikey delete 5f3d8790c9022019903c1234 --force -P
-         myOM -o json
+         mongocli iam org apikey delete 5f3d8790c9022019903c1234 --force -P myOM -o json
 
       The previous command updates the |api| key and 
       prints the following to the terminal in |json| format.

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

@@ -121,16 +121,17 @@ Examples
    .. tab:: JSON Output
       :tabid: json-output
 
-      The following command creates an |api| key using the
-      ``myOM`` profile, which contains credentials. The output is
-      returned in |json| format.
+      The following command retrieves the |api| keys for an 
+      organization using the ``myOM`` profile, which contains 
+      credentials. The output is returned in |json| format.
 
       .. code-block:: sh
 
          mongocli iam organization apikey list --orgId 5a1b39eec902201990f12345 -P myOM --output json
 
-      The previous command creates the |api| key and 
-      prints the following to the terminal in |json| format.
+      The previous command retrieves the |api| keys for an 
+      organization and prints the following to the terminal in |json| 
+      format.
 
       .. code-block:: json
          :copyable: false

source/reference/iam/iam-project-apikey-assign.txt

@@ -0,0 +1,163 @@
+.. _mcli-iam-project-apikey-assign:
+
+==================================
+mongocli iam project apikey assign
+==================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+The ``iam project apikey assign`` command assigns an organization |api| 
+key to a project and updates the |api| key roles.
+
+You must have ``GROUP_USER_ADMIN`` privileges to assign an 
+|api| key to a project.
+
+.. _mcli-iam-project-apikey-assign-syntax:
+
+Syntax
+------
+
+.. code-block:: text 
+
+   mongocli iam project|projects apiKey|apiKeys|apikeys assign|update <api-key-id>
+        [ --projectId <project-id> ]
+        [ --output|-o <output-format> ]
+        [ --profile|-P <profile-name> ]
+        [ --role <list-of-roles> ]
+
+.. include:: /includes/fact-command-line-help.rst
+
+.. _mcli-iam-project-apikey-assign-arguments:
+
+Arguments  
+---------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 60 10
+
+   * - Argument 
+     - Type 
+     - Description 
+     - Required?
+
+   * - ``<api-key-id>``
+     - string
+     - Unique identifier for this API key.
+     - yes
+
+.. _mcli-iam-project-apikey-assign-options:
+
+Options 
+-------
+
+.. list-table:: 
+   :header-rows: 1
+   :widths: 20 10 60 10
+
+   * - Option
+     - Type 
+     - Description 
+     - Required? 
+
+   * - ``--projectId``
+     - string
+     - Unique identifier of the project of the |api| key you want
+       to update.
+       
+       If specified, this value overrides any project ID
+       stored in your :ref:`profile <mcli-profiles>` or
+       :ref:`environment variable <mcli-env-var>`.
+
+       If omitted, your profile must contain the
+       project ID.
+     - no
+
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
+   * - ``--profile``, ``-P`` 
+     - string 
+     - Name of the profile where your credentials are saved.
+
+       If omitted, uses the {+default-profile+}. To learn more about 
+       creating a profile, see :ref:`mcli-configure`.
+     - no
+
+   * - ``--role`` 
+     - string 
+     - Role or roles to assign to the |api| key. To assign more than
+       one role, you can specify each role with a ``--role`` flag or
+       specify the roles in a comma-separated list with one ``--role``
+       flag. 
+     - no
+
+.. _mcli-iam-project-apikey-assign-output:
+
+Output
+------
+
+If the command succeeds, it returns the following output in the default
+format. If the command returns errors, see :ref:`Troubleshooting
+<troubleshooting>` for recommended solutions.
+
+.. code-block:: sh
+   :copyable: false
+
+   API Key successfully assigned.
+
+.. include:: /includes/fact-default-output.rst
+
+- :atlas:`Atlas API </reference/api/projectApiKeys/assign-one-org-apiKey-to-one-project/#response>`
+- :cloudmgr:`Cloud Manager API </reference/api/api-keys/project/assign-one-org-apiKey-to-one-project/#response>`
+- :opsmgr:`Ops Manager API </reference/api/api-keys/project/assign-one-org-apiKey-to-one-project/#response>`
+
+.. _mcli-iam-project-apikey-assign-examples:
+
+Examples
+--------
+
+.. tabs::
+
+   .. tab:: Default Output
+      :tabid: default-output
+
+      The following command assigns an organization |api| key to a 
+      project and updates its role using the
+      {+default-profile+}, which contains credentials and the project 
+      ID of the project to assign the |api| key to. The output is 
+      returned in the default format.
+
+      .. code-block:: sh
+
+         mongocli iam project apikey assign 5f46ae53d58b421fe3edc115 --role GROUP_OWNER
+
+      The previous command prints the following to the terminal.
+
+      .. code-block:: json
+         :copyable: false
+
+         API Key successfully assigned.
+
+   .. tab:: JSON Output
+      :tabid: json-output
+
+      The following command assigns an organization |api| key to a 
+      project and updates its role using the ``myOM`` profile, which 
+      contains credentials and specifies the the |onprem| service. The 
+      output is returned in |json| format.
+
+      .. code-block:: sh
+
+         mongocli iam project apikey assign 5f46ae53d58b421fe3edc115 --role GROUP_DATA_ACCESS_READ_WRITE --output json
+         
+      The previous command updates the |api| key does not return a 
+      |json| response.