]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: update rgw admin api req params for get user info 55071/head
authorAli Maredia <amaredia@redhat.com>
Fri, 5 Jan 2024 20:13:41 +0000 (20:13 +0000)
committerZac Dover <zac.dover@proton.me>
Fri, 5 Jan 2024 23:21:21 +0000 (09:21 +1000)
Signed-off-by: Ali Maredia <amaredia@redhat.com>
(cherry picked from commit e6c58dcd614f71efa4de2f781b8425c480af285e)

doc/radosgw/adminops.rst

index 0974b95c5862b4d22443ad70982b3e12c5f2376d..f1faac6b1c2f4d991c8db02f91a49e5447c8f9c2 100644 (file)
@@ -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
 ~~~~~~~~~~~~~~~~~