From: Ali Maredia <amaredia@redhat.com>
Date: Fri, 5 Jan 2024 20:13:41 +0000 (+0000)
Subject: doc: update rgw admin api req params for get user info
X-Git-Tag: v17.2.8~613^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=5e21df8dedb0aafe35a8c6daa26fa2179f4aa9d2;p=ceph.git

doc: update rgw admin api req params for get user info

Signed-off-by: Ali Maredia <amaredia@redhat.com>
(cherry picked from commit e6c58dcd614f71efa4de2f781b8425c480af285e)
---

diff --git a/doc/radosgw/adminops.rst b/doc/radosgw/adminops.rst
index b3e0a11832b58..5f69d31ed9187 100644
--- a/doc/radosgw/adminops.rst
+++ b/doc/radosgw/adminops.rst
@@ -275,6 +275,9 @@ Get User Info
 
 Get user information.
 
+Either a ``uid`` or ``access-key`` must be supplied as a request parameter. We recommend supplying uid.
+If both are provided but correspond to different users, the info for the user specified with ``uid`` will be returned.
+
 :caps: users=read
 
 
@@ -297,6 +300,13 @@ Request Parameters
 :Example: ``foo_user``
 :Required: Yes
 
+``access-key``
+
+:Description: The S3 access key of the user for which the information is requested.
+:Type: String
+:Example: ``ABCD0EF12GHIJ2K34LMN``
+:Required: No
+
 
 Response Entities
 ~~~~~~~~~~~~~~~~~