Skip to content

Commit f205b40

Browse files
committed
Automated API spec update
1 parent 5d8b80c commit f205b40

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

wsapi_v2.json

+15-15
Original file line numberDiff line numberDiff line change
@@ -204,8 +204,8 @@
204204
"example": {
205205
"Code": "8642603384107437",
206206
"Company": "ISECURE OY",
207-
"WsUserId": "...",
208-
"wstargetid": "..."
207+
"WsTargetId": "...",
208+
"WsUserId": "..."
209209
},
210210
"properties": {
211211
"Code": {
@@ -216,20 +216,20 @@
216216
"description": "Company name as registered with bank (e.g. full capital letters without Oy, see contract)",
217217
"type": "string"
218218
},
219-
"WsUserId": {
220-
"description": "WebServices channel user id as in contract with bank",
219+
"WsTargetId": {
220+
"description": "WebServices channel target id as in contract with bank",
221221
"type": "string"
222222
},
223-
"wstargetid": {
224-
"description": "WebServices channel target id as in contract with bank",
223+
"WsUserId": {
224+
"description": "WebServices channel user id as in contract with bank",
225225
"type": "string"
226226
}
227227
},
228228
"required": [
229229
"Code",
230230
"Company",
231231
"WsUserId",
232-
"wstargetid"
232+
"WsTargetId"
233233
],
234234
"type": "object"
235235
},
@@ -938,7 +938,7 @@
938938
},
939939
"termsOfService": "https://www.isecure.fi/ws-api-terms",
940940
"title": "ISECure WS Channel API",
941-
"version": "v2.3.0",
941+
"version": "v2.3.1",
942942
"x-logo": {
943943
"backgroundColor": "#FFFFFF",
944944
"url": "https://www.isecure.fi/images/isecure-small-logo.png"
@@ -1030,7 +1030,7 @@
10301030
"consumes": [
10311031
"application/json"
10321032
],
1033-
"description": "Provide _code_ received to _email_ address for email address verification. Provide also _accesstoken_ received during login.",
1033+
"description": "Provide _Code_ received to _Email_ address for email address verification. Provide also _AccessToken_ received during login.",
10341034
"operationId": "VerifyEmail",
10351035
"parameters": [
10361036
{
@@ -1290,7 +1290,7 @@
12901290
"consumes": [
12911291
"application/json"
12921292
],
1293-
"description": "Set new _password_ for user with _email_. Provide received SMS _code_.\n\n**NOTE:** the password must be encrypted, see Register for more details.\n",
1293+
"description": "Set new _password_ for user with _Email_. Provide received SMS _Code_.\n\n**NOTE:** the password must be encrypted, see Register for more details.\n",
12941294
"operationId": "PasswordReset",
12951295
"parameters": [
12961296
{
@@ -1381,7 +1381,7 @@
13811381
"consumes": [
13821382
"application/json"
13831383
],
1384-
"description": "Confirm phone number for _email_ _mode_ user, with _code_ received via SMS.",
1384+
"description": "Confirm phone number for _Email_ _Mode_ user, with _Code_ received via SMS.",
13851385
"operationId": "VerifyPhone",
13861386
"parameters": [
13871387
{
@@ -1940,7 +1940,7 @@
19401940
"consumes": [
19411941
"application/json"
19421942
],
1943-
"description": "Provide WS-Channel user id, _wsuserid_, _wstargetid_, _company_, and PIN _code_ for _bank_ certificate enrollment. _Company_ must match with the contract with the bank and is part of enrollment process. Note that certificate private key is securely generated and stored encrypted on service side and never leaves from there. Certificates are automatically renewed when needed.",
1943+
"description": "Provide WS-Channel user id, _WsUserId_, _WsTargetId_, _Company_, and PIN _Code_ for _Bank_ certificate enrollment. _Company_ must match with the contract with the bank and is part of enrollment process. Note that certificate private key is securely generated and stored encrypted on service side and never leaves from there. Certificates are automatically renewed when needed.",
19441944
"operationId": "EnrollCert",
19451945
"parameters": [
19461946
{
@@ -2040,7 +2040,7 @@
20402040
"consumes": [
20412041
"application/json"
20422042
],
2043-
"description": "Provide _wsuserid_, _wstargetid_, _company_, _privatekey_, and _certificate_ for importing existing WS Channel certificate and private key. _Company_ must match with the contract with the bank. Certificate(s) and private key(s) must be PEM formatted.\n\n- **NOTE:** _enccertificate_ and _encprivatekey_ are for DanskeBank only.",
2043+
"description": "Provide _WsUserId_, _WsTargetId_, _Company_, _PrivateKey_, and _Certificate_ for importing existing WS Channel certificate and private key. _Company_ must match with the contract with the bank. Certificate(s) and private key(s) must be PEM formatted.\n\n- **NOTE:** _EncCcertificate_ and _EncPrivatekey_ are for DanskeBank only.",
20442044
"operationId": "ImportCert",
20452045
"parameters": [
20462046
{
@@ -3099,7 +3099,7 @@
30993099
"consumes": [
31003100
"application/json"
31013101
],
3102-
"description": "After `getchallenge`, call `login` with _email_, _mode_, and RSA encrypted _admin_ or _data_ account _password_ and _challenge timestamp_. For further API calls (requiring authroization), include the received _idtoken_ into the Authorization header of the request (pass idtoken as required parameter with the client SDK API calls). The _IdToken_ expires in _ExpiresIn_ seconds, after which new login must be performed.\n\n- **NOTE:** In case SMS _code_ is required, the call returns _session_.\n- **NOTE:** If _email_ has not been yet verified, successful login provides only _accesstoken_ that must be used to verify email address.\n",
3102+
"description": "After `getchallenge`, call `login` with _Email_, _Mode_, and RSA encrypted _admin_ or _data_ account _password_ and _challenge timestamp_. For further API calls (requiring authroization), include the received _IdToken_ into the Authorization header of the request (pass idtoken as required parameter with the client SDK API calls). The _IdToken_ expires in _ExpiresIn_ seconds, after which new login must be performed.\n\n- **NOTE:** In case SMS _Code_ is required, the call returns _Session_.\n- **NOTE:** If _Email_ has not been yet verified, successful login provides only _AccessToken_ that must be used to verify email address.\n",
31033103
"operationId": "Login",
31043104
"parameters": [
31053105
{
@@ -3190,7 +3190,7 @@
31903190
"consumes": [
31913191
"application/json"
31923192
],
3193-
"description": "Send SMS _code_ along with previously received _session_ token. If _email_ has not been yet verified, successful login provides only _accesstoken_ that must be used to verify email address. If email is already verified and the login succeeds, add the _idtoken_ from the login response as Authorization header in API requests requiring authorization (i.e. pass as parameter to client SDK API calls). _IdToken_ expires in _ExpiresIn_ seconds.",
3193+
"description": "Send SMS _Code_ along with previously received _Session_ token. If _Email_ has not been yet verified, successful login provides only _AccessToken_ that must be used to verify email address. If email is already verified and the login succeeds, add the _IdToken_ from the login response as Authorization header in API requests requiring authorization (i.e. pass as parameter to client SDK API calls). _IdToken_ expires in _ExpiresIn_ seconds.",
31943194
"operationId": "LoginMFA",
31953195
"parameters": [
31963196
{

0 commit comments

Comments
 (0)