Browse Source

Merge pull request #3043 from xiang90/update_auth_doc

auth: update the auth doc
Xiang Li 10 years ago
parent
commit
b3cb5f9e4e
1 changed files with 24 additions and 2 deletions
  1. 24 2
      Documentation/auth_api.md

+ 24 - 2
Documentation/auth_api.md

@@ -175,7 +175,8 @@ PUT  /v2/auth/users/charlie
         201 Created
         400 Bad Request
         401 Unauthorized
-        409 Conflict (when granting duplicated roles or revoking non-existing roles)
+        404 Not Found (update non-existent users)
+        409 Conflict (when granting duplicated roles or revoking non-existent roles)
     200 Headers:
         Content-type: application/json
     200 Body:
@@ -266,7 +267,8 @@ PUT  /v2/auth/roles/rkt
         201 Created
         400 Bad Request
         401 Unauthorized
-        409 Conflict (when granting duplicated permission or revoking non-existing permission)
+        404 Not Found (update non-existent roles)
+        409 Conflict (when granting duplicated permission or revoking non-existent permission)
     200 Body: 
         JSON state of the role
 
@@ -303,6 +305,26 @@ PUT  /v2/auth/users/root
 PUT  /v2/auth/enable
 ```
 
+### Modify guest role (revoke write permission)
+
+```
+PUT  /v2/auth/users/guest
+    Headers:
+        Authorization: Basic <root:betterRootPW!>
+    Put Body:
+      {
+          "role" : "guest",
+          "revoke" : {
+            "kv" : {
+              "write": [
+                "*"
+              ]
+            }
+          }
+        }
+      }
+```
+
 
 ### Create Roles for the Applications