summaryrefslogtreecommitdiffstats
path: root/doc/radosgw/adminops.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-23 16:45:13 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-23 16:45:13 +0000
commit389020e14594e4894e28d1eb9103c210b142509e (patch)
tree2ba734cdd7a243f46dda7c3d0cc88c2293d9699f /doc/radosgw/adminops.rst
parentAdding upstream version 18.2.2. (diff)
downloadceph-389020e14594e4894e28d1eb9103c210b142509e.tar.xz
ceph-389020e14594e4894e28d1eb9103c210b142509e.zip
Adding upstream version 18.2.3.upstream/18.2.3
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/radosgw/adminops.rst')
-rw-r--r--doc/radosgw/adminops.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/radosgw/adminops.rst b/doc/radosgw/adminops.rst
index 0974b95c5..f1faac6b1 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
~~~~~~~~~~~~~~~~~