3636 ' 400 ' :
3737 description : Bad Request
3838 ' 409 ' :
39- description : ' Conflict, Api key already exists.'
39+ description : ' Conflict, Api Key already exists.'
4040 description : Create API Key for the Merchant given in the X-Settle-Merchant header.
4141 requestBody :
4242 content :
@@ -734,6 +734,23 @@ paths:
734734 examples : {}
735735 operationId : merchant.balance.get
736736 description : Get Merchant Account Balance
737+ ' /api_key/{x_settle_user} ' :
738+ parameters :
739+ - $ref : ' #/components/parameters/x_settle_user'
740+ put :
741+ summary : merchant.apiKeys.update
742+ operationId : merchant.apiKeys.update
743+ responses :
744+ ' 204 ' :
745+ description : No Content
746+ description : Update API Key
747+ delete :
748+ summary : merchant.apiKeys.delete
749+ operationId : merchant.apiKeys.delete
750+ responses :
751+ ' 204 ' :
752+ description : No Content
753+ description : Delete API Key
737754components :
738755 schemas :
739756 payment.request.create :
@@ -1296,26 +1313,30 @@ components:
12961313 required :
12971314 - email
12981315 apiKeys.update :
1299- title : ' Request Body: users .update'
1316+ title : ' Request Body: apiKeys .update'
13001317 type : object
13011318 description : Update API Key
1319+ x-examples : {}
13021320 properties :
1321+ label :
1322+ type : string
1323+ description : User given name to API Key.
1324+ key_type :
1325+ type : string
1326+ roles :
1327+ type : string
13031328 netmask :
13041329 type : string
13051330 description : ' Limit user connections by netmask, for example 192.168.1.0/24'
13061331 format : ipv4
13071332 example : 192.168.1.0/24
1308- label :
1309- type : string
1310- description : User given name to RSA key/secret.
13111333 secret :
13121334 type : string
13131335 minLength : 8
13141336 maxLength : 64
13151337 description : Secret used when authenticating with Settle.
13161338 pubkey :
13171339 $ref : ../models/PubKey.yaml
1318- x-examples : {}
13191340 apiKeys.create :
13201341 title : ' Request Body: apiKeys.create'
13211342 type : object
@@ -1325,6 +1346,9 @@ components:
13251346 id :
13261347 type : string
13271348 description : User ID
1349+ label :
1350+ type : string
1351+ description : User given name to API Key.
13281352 key_type :
13291353 type : string
13301354 enum :
@@ -1921,6 +1945,13 @@ components:
19211945 schema :
19221946 type : string
19231947 description : Merchant SSP User ID
1948+ x_settle_user :
1949+ name : x_settle_user
1950+ in : path
1951+ required : true
1952+ schema :
1953+ type : string
1954+ description : API Key ID created by either Settle or User
19241955 examples : {}
19251956tags :
19261957 - name : Info
0 commit comments