Browse code

Update docs to mention identity token usage for /auth

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)

Derek McGowan authored on 2016/03/05 06:31:40
Showing 2 changed files
... ...
@@ -125,6 +125,7 @@ This section lists each version from latest to oldest.  Each listing includes a
125 125
 * `GET /info` now returns `KernelMemory` field, showing if "kernel memory limit" is supported.
126 126
 * `POST /containers/create` now takes `PidsLimit` field, if the kernel is >= 4.3 and the pids cgroup is supported.
127 127
 * `GET /containers/(id or name)/stats` now returns `pids_stats`, if the kernel is >= 4.3 and the pids cgroup is supported.
128
+* `POST /auth` now returns an `IdentityToken` when supported by a registry.
128 129
 
129 130
 ### v1.22 API changes
130 131
 
... ...
@@ -1957,11 +1957,11 @@ Request Headers:
1957 1957
     }
1958 1958
         ```
1959 1959
 
1960
-    - Token based login:
1960
+    - Identity token based login:
1961 1961
 
1962 1962
         ```
1963 1963
     {
1964
-            "registrytoken": "9cbaf023786cd7..."
1964
+            "identitytoken": "9cbaf023786cd7..."
1965 1965
     }
1966 1966
         ```
1967 1967
 
... ...
@@ -2091,7 +2091,8 @@ Status Codes:
2091 2091
 
2092 2092
 `POST /auth`
2093 2093
 
2094
-Get the default username and email
2094
+Validate credentials for a registry and get identity token,
2095
+if available, for accessing the registry without password.
2095 2096
 
2096 2097
 **Example request**:
2097 2098
 
... ...
@@ -2099,9 +2100,8 @@ Get the default username and email
2099 2099
     Content-Type: application/json
2100 2100
 
2101 2101
     {
2102
-         "username":" hannibal",
2103
-         "password: "xxxx",
2104
-         "email": "hannibal@a-team.com",
2102
+         "username": "hannibal",
2103
+         "password": "xxxx",
2105 2104
          "serveraddress": "https://index.docker.io/v1/"
2106 2105
     }
2107 2106
 
... ...
@@ -2109,6 +2109,11 @@ Get the default username and email
2109 2109
 
2110 2110
     HTTP/1.1 200 OK
2111 2111
 
2112
+    {
2113
+         "Status": "Login Succeeded",
2114
+         "IdentityToken": "9cbaf023786cd7..."
2115
+    }
2116
+
2112 2117
 Status Codes:
2113 2118
 
2114 2119
 -   **200** – no error