1515 license :
1616 name : Apache 2.0
1717 url : https://www.apache.org/licenses/LICENSE-2.0.html
18- version : 0.26.40
18+ version : 0.26.42
1919host : demo.ziti.dev
2020basePath : /edge/client/v1
2121paths :
@@ -1818,22 +1818,50 @@ paths:
18181818 post :
18191819 description : present a OTT and CSR to receive a long-lived client certificate
18201820 consumes :
1821- - application/pkcs10
1821+ - application/pkcs7
18221822 - application/json
18231823 - application/x-pem-file
18241824 - text/plain
18251825 produces :
1826- - application/x-pem-file
18271826 - application/json
18281827 tags :
18291828 - Enroll
18301829 summary : Enroll an identity via one-time-token
18311830 operationId : enroll
18321831 responses :
18331832 " 200 " :
1834- description : A response for multi-format legacy enrollment.
1833+ description : A response containing and identities client certificate chains
18351834 schema :
1836- type : string
1835+ $ref : ' #/definitions/enrollmentCertsEnvelope'
1836+ " 400 " :
1837+ description : The supplied request contains invalid fields or could not be
1838+ parsed (json and non-json bodies). The error's code, message, and cause
1839+ fields can be inspected for further information
1840+ schema :
1841+ $ref : ' #/definitions/apiErrorEnvelope'
1842+ examples :
1843+ application/json :
1844+ error :
1845+ args :
1846+ urlVars : {}
1847+ cause :
1848+ details :
1849+ context : (root)
1850+ field : (root)
1851+ property : fooField3
1852+ field : (root)
1853+ message : ' (root): fooField3 is required'
1854+ type : required
1855+ value :
1856+ fooField : abc
1857+ fooField2 : def
1858+ causeMessage : schema validation failed
1859+ code : COULD_NOT_VALIDATE
1860+ message : The supplied request contains an invalid document
1861+ requestId : ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
1862+ meta :
1863+ apiEnrollmentVersion : 0.0.1
1864+ apiVersion : 0.0.1
18371865 " 404 " :
18381866 description : The requested resource does not exist
18391867 schema :
@@ -1883,6 +1911,10 @@ paths:
18831911 - type : string
18841912 name : method
18851913 in : query
1914+ - name : body
1915+ in : body
1916+ schema :
1917+ $ref : ' #/definitions/genericEnroll'
18861918 /enroll/ca :
18871919 post :
18881920 description : |
@@ -1900,6 +1932,35 @@ paths:
19001932 description : Base empty response
19011933 schema :
19021934 $ref : ' #/definitions/empty'
1935+ " 400 " :
1936+ description : The supplied request contains invalid fields or could not be
1937+ parsed (json and non-json bodies). The error's code, message, and cause
1938+ fields can be inspected for further information
1939+ schema :
1940+ $ref : ' #/definitions/apiErrorEnvelope'
1941+ examples :
1942+ application/json :
1943+ error :
1944+ args :
1945+ urlVars : {}
1946+ cause :
1947+ details :
1948+ context : (root)
1949+ field : (root)
1950+ property : fooField3
1951+ field : (root)
1952+ message : ' (root): fooField3 is required'
1953+ type : required
1954+ value :
1955+ fooField : abc
1956+ fooField2 : def
1957+ causeMessage : schema validation failed
1958+ code : COULD_NOT_VALIDATE
1959+ message : The supplied request contains an invalid document
1960+ requestId : ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
1961+ meta :
1962+ apiEnrollmentVersion : 0.0.1
1963+ apiVersion : 0.0.1
19031964 " 404 " :
19041965 description : The requested resource does not exist
19051966 schema :
@@ -2025,6 +2086,35 @@ paths:
20252086 (server chain, server cert, CAs).
20262087 schema :
20272088 $ref : ' #/definitions/enrollmentCertsEnvelope'
2089+ " 400 " :
2090+ description : The supplied request contains invalid fields or could not be
2091+ parsed (json and non-json bodies). The error's code, message, and cause
2092+ fields can be inspected for further information
2093+ schema :
2094+ $ref : ' #/definitions/apiErrorEnvelope'
2095+ examples :
2096+ application/json :
2097+ error :
2098+ args :
2099+ urlVars : {}
2100+ cause :
2101+ details :
2102+ context : (root)
2103+ field : (root)
2104+ property : fooField3
2105+ field : (root)
2106+ message : ' (root): fooField3 is required'
2107+ type : required
2108+ value :
2109+ fooField : abc
2110+ fooField2 : def
2111+ causeMessage : schema validation failed
2112+ code : COULD_NOT_VALIDATE
2113+ message : The supplied request contains an invalid document
2114+ requestId : ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
2115+ meta :
2116+ apiEnrollmentVersion : 0.0.1
2117+ apiVersion : 0.0.1
20282118 " 429 " :
20292119 description : The resource requested is rate limited and the rate limit has
20302120 been exceeded
@@ -2084,6 +2174,35 @@ paths:
20842174 (server chain, server cert, CAs).
20852175 schema :
20862176 $ref : ' #/definitions/enrollmentCertsEnvelope'
2177+ " 400 " :
2178+ description : The supplied request contains invalid fields or could not be
2179+ parsed (json and non-json bodies). The error's code, message, and cause
2180+ fields can be inspected for further information
2181+ schema :
2182+ $ref : ' #/definitions/apiErrorEnvelope'
2183+ examples :
2184+ application/json :
2185+ error :
2186+ args :
2187+ urlVars : {}
2188+ cause :
2189+ details :
2190+ context : (root)
2191+ field : (root)
2192+ property : fooField3
2193+ field : (root)
2194+ message : ' (root): fooField3 is required'
2195+ type : required
2196+ value :
2197+ fooField : abc
2198+ fooField2 : def
2199+ causeMessage : schema validation failed
2200+ code : COULD_NOT_VALIDATE
2201+ message : The supplied request contains an invalid document
2202+ requestId : ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
2203+ meta :
2204+ apiEnrollmentVersion : 0.0.1
2205+ apiVersion : 0.0.1
20872206 " 401 " :
20882207 description : The supplied session does not have the correct access rights
20892208 to request this resource
@@ -2151,6 +2270,35 @@ paths:
21512270 description : A response containing and identities client certificate chains
21522271 schema :
21532272 $ref : ' #/definitions/enrollmentCertsEnvelope'
2273+ " 400 " :
2274+ description : The supplied request contains invalid fields or could not be
2275+ parsed (json and non-json bodies). The error's code, message, and cause
2276+ fields can be inspected for further information
2277+ schema :
2278+ $ref : ' #/definitions/apiErrorEnvelope'
2279+ examples :
2280+ application/json :
2281+ error :
2282+ args :
2283+ urlVars : {}
2284+ cause :
2285+ details :
2286+ context : (root)
2287+ field : (root)
2288+ property : fooField3
2289+ field : (root)
2290+ message : ' (root): fooField3 is required'
2291+ type : required
2292+ value :
2293+ fooField : abc
2294+ fooField2 : def
2295+ causeMessage : schema validation failed
2296+ code : COULD_NOT_VALIDATE
2297+ message : The supplied request contains an invalid document
2298+ requestId : ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
2299+ meta :
2300+ apiEnrollmentVersion : 0.0.1
2301+ apiVersion : 0.0.1
21542302 " 404 " :
21552303 description : The requested resource does not exist
21562304 schema :
@@ -2217,6 +2365,35 @@ paths:
22172365 description : Base empty response
22182366 schema :
22192367 $ref : ' #/definitions/empty'
2368+ " 400 " :
2369+ description : The supplied request contains invalid fields or could not be
2370+ parsed (json and non-json bodies). The error's code, message, and cause
2371+ fields can be inspected for further information
2372+ schema :
2373+ $ref : ' #/definitions/apiErrorEnvelope'
2374+ examples :
2375+ application/json :
2376+ error :
2377+ args :
2378+ urlVars : {}
2379+ cause :
2380+ details :
2381+ context : (root)
2382+ field : (root)
2383+ property : fooField3
2384+ field : (root)
2385+ message : ' (root): fooField3 is required'
2386+ type : required
2387+ value :
2388+ fooField : abc
2389+ fooField2 : def
2390+ causeMessage : schema validation failed
2391+ code : COULD_NOT_VALIDATE
2392+ message : The supplied request contains an invalid document
2393+ requestId : ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
2394+ meta :
2395+ apiEnrollmentVersion : 0.0.1
2396+ apiVersion : 0.0.1
22202397 " 429 " :
22212398 description : The resource requested is rate limited and the rate limit has
22222399 been exceeded
@@ -2260,6 +2437,35 @@ paths:
22602437 description : Base empty response
22612438 schema :
22622439 $ref : ' #/definitions/empty'
2440+ " 400 " :
2441+ description : The supplied request contains invalid fields or could not be
2442+ parsed (json and non-json bodies). The error's code, message, and cause
2443+ fields can be inspected for further information
2444+ schema :
2445+ $ref : ' #/definitions/apiErrorEnvelope'
2446+ examples :
2447+ application/json :
2448+ error :
2449+ args :
2450+ urlVars : {}
2451+ cause :
2452+ details :
2453+ context : (root)
2454+ field : (root)
2455+ property : fooField3
2456+ field : (root)
2457+ message : ' (root): fooField3 is required'
2458+ type : required
2459+ value :
2460+ fooField : abc
2461+ fooField2 : def
2462+ causeMessage : schema validation failed
2463+ code : COULD_NOT_VALIDATE
2464+ message : The supplied request contains an invalid document
2465+ requestId : ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
2466+ meta :
2467+ apiEnrollmentVersion : 0.0.1
2468+ apiVersion : 0.0.1
22632469 " 404 " :
22642470 description : The requested resource does not exist
22652471 schema :
@@ -4632,6 +4838,21 @@ definitions:
46324838 type : string
46334839 token :
46344840 type : string
4841+ genericEnroll :
4842+ type : object
4843+ properties :
4844+ certCsr :
4845+ type : string
4846+ clientCsr :
4847+ type : string
4848+ name :
4849+ type : string
4850+ password :
4851+ $ref : ' #/definitions/password'
4852+ serverCertCsr :
4853+ type : string
4854+ username :
4855+ $ref : ' #/definitions/username'
46354856 identityAuthenticators :
46364857 type : object
46374858 properties :
0 commit comments