Skip to content

Commit e6c58dc

Browse files
committed
doc: update rgw admin api req params for get user info
Signed-off-by: Ali Maredia <[email protected]>
1 parent d451898 commit e6c58dc

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/radosgw/adminops.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,9 @@ Get User Info
275275

276276
Get user information.
277277

278+
Either a ``uid`` or ``access-key`` must be supplied as a request parameter. We recommend supplying uid.
279+
If both are provided but correspond to different users, the info for the user specified with ``uid`` will be returned.
280+
278281
:caps: users=read
279282

280283

@@ -297,6 +300,13 @@ Request Parameters
297300
:Example: ``foo_user``
298301
:Required: Yes
299302

303+
``access-key``
304+
305+
:Description: The S3 access key of the user for which the information is requested.
306+
:Type: String
307+
:Example: ``ABCD0EF12GHIJ2K34LMN``
308+
:Required: No
309+
300310

301311
Response Entities
302312
~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)