From: Abhishek Lekshmanan <abhishek@suse.com>
Date: Thu, 20 Jul 2017 09:05:24 +0000 (+0200)
Subject: doc: mention that tenant names may be specified in adminops api
X-Git-Tag: v12.1.3~24^2~23^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=5c8d27363cec3a33ae4eea8065eff76b4f302ab1;p=ceph.git

doc: mention that tenant names may be specified in adminops api

We already allow for tenant names to be specified as a part of uid in
the adminops api, mention this. Also mention about ``tenant`` in the
json response we send.

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
---

diff --git a/doc/radosgw/adminops.rst b/doc/radosgw/adminops.rst
index 28c02164b0d..597f4fe5d26 100644
--- a/doc/radosgw/adminops.rst
+++ b/doc/radosgw/adminops.rst
@@ -342,6 +342,7 @@ Request Parameters
 :Type: String
 :Example: ``foo_user``
 :Required: Yes
+A tenant name may also specified as a part of ``uid``, by following the syntax ``tenant$user``, refer to `Multitenancy`_ for more details.
 
 ``display-name``
 
@@ -418,6 +419,11 @@ If successful, the response contains the user information.
 :Description: A container for the user data information.
 :Type: Container
 
+``tenant``
+:Description: The tenant which user is a part of
+:Type: String
+:Parent: ``user``
+
 ``user_id``
 
 :Description: The user id.
@@ -1924,3 +1930,4 @@ Standard Error Responses
 
 .. _Admin Guide: ../admin
 .. _Quota Management: ../admin#quota-management
+.. _Multitenancy: ./multitenancy