Last active
October 16, 2017 09:32
-
-
Save varun-raj/9e63668e1a3fa10620ec9a3f19d52eb2 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "version": "0.2.0", | |
| "title": "SSMS Worker API" | |
| }, | |
| "host": "18.194.193.140:3001", | |
| "paths": { | |
| "/api/systemtoken": { | |
| "post": { | |
| "description": "Erzeugtdd aus den übergebenen Eingabedaten ein System-Token, welches für alle weiteren API-Aufrufe notwendig ist.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "tokenParam", | |
| "description": "Token-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/SystemTokenParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/SystemTokenResponse" | |
| } | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } } | |
| } | |
| }, | |
| "/api/login": { | |
| "post": { | |
| "description": "Loggt den User ein.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "LoginParams", | |
| "description": "Login-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/LoginParams" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/LoginResult" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/loginBasic": { | |
| "post": { | |
| "description": "Loggt den User ein.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "LoginParams", | |
| "description": "Login-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/LoginBasicParams" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/LoginBasicResult" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LoginSign": { | |
| "post": { | |
| "description": "Meldet den Benutzer an.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "transactionParam", | |
| "description": "Transaction-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/LoginSignParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/LoginSignResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/MgtError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/getLoginSignResult": { | |
| "post": { | |
| "description": "Liefert das Ergebnis des LoginSign.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "transactionResultParam", | |
| "description": "TransactionResult-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/TransactionResultParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/TransactionResultResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/loginOfflineOTP": { | |
| "post": { | |
| "description": "Loggt den User ein.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "LoginParams", | |
| "description": "Login-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/LoginOfflineOTPParams" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/LoginOfflineOTPResult" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/loginWebview": { | |
| "post": { | |
| "description": "Loggt den OTP ein.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "otpParams", | |
| "description": "Login-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/OtpLoginParams" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/LoginResult" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/loginQrcode": { | |
| "post": { | |
| "description": "Loggt den OTP ein.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "otpParams", | |
| "description": "Login-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/LoginQrcodeParams" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/LoginQrcodeResult" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/logOffDevice": { | |
| "post": { | |
| "description": "Logt ein Gerät aus.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "LogOffDeviceParams", | |
| "description": "LogOff-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/LogOffDeviceParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response" | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/user/devices": { | |
| "post": { | |
| "description": "Liefert die Liste der Geräte.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "deviceParams", | |
| "description": "Device-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/GetDevicesParams" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/DevicesStateInfo" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/user/add": { | |
| "post": { | |
| "description": "Fügt einen neuen Benutzer hinzu.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "userParams", | |
| "description": "User-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/AddUserParams" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/AddUserResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/MgtError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/user/remove": { | |
| "post": { | |
| "description": "Entfern einen Benutzer.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "userParams", | |
| "description": "User-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RemoveUserParams" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/RemoveUserResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/MgtError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/user/logOff": { | |
| "post": { | |
| "description": "Logt einen Benutzer ab.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "LogOff-Params", | |
| "description": "LogOff-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/LogOffUserParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/LogOffUserResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/sendPushNotification": { | |
| "post": { | |
| "description": "Sendet eine PushNotification an ein Geräte.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "pushNotificationParam", | |
| "description": "Device-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/PushNotificationParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response" | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/createActivationCodeEx": { | |
| "post": { | |
| "description": "Erstellt einen Atkivierungscode.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "activationCodeParam", | |
| "description": "ActivationsCode-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ActivationCodeParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/ActivationCodeResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/MgtError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/getActivationCodes": { | |
| "post": { | |
| "description": "Liefert alle Atkivierungscodes zum Benutzer.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "getActivationCodeParam", | |
| "description": "GetActivationsCode-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/GetActivationCodeParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/GetActivationCodeResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/MgtError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/startTransactionEx": { | |
| "post": { | |
| "description": "Erstellt eine neue Transaktion.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "transactionParam", | |
| "description": "Transaction-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/StartTransactionParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/StartTransactionResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/MgtError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/getTransactionResultEx": { | |
| "post": { | |
| "description": "Liefert das Ergebnis der Transaktion.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "transactionResultParam", | |
| "description": "TransactionResult-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/TransactionResultParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/TransactionResultResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/pollTransactionResult": { | |
| "post": { | |
| "description": "Fragt das Ergebnis der Transaktion.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "transactionResultParam", | |
| "description": "PollTransactionResult-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/PollTransactionResultParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/PollTransactionResultResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/getDeviceInfo": { | |
| "post": { | |
| "description": "Liefert Informationen zum Gerät.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "deviceInfoParam", | |
| "description": "DeviceInfo-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/DeviceInfoParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/DeviceInfoResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/lockDeviceByDeviceId": { | |
| "post": { | |
| "description": "Sperrt ein Device.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "lockDeviceParam", | |
| "description": "LockDevice-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/LockDeviceParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/LockDeviceResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/MgtError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/unlockDeviceByDeviceId": { | |
| "post": { | |
| "description": "Entsperrt ein Device.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "unlockDeviceParam", | |
| "description": "UnlockDevice-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/UnlockDeviceParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/UnlockDeviceResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/MgtError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/getProperties": { | |
| "post": { | |
| "description": "Liefert die Properties zu einem Gerät.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "getPropertiesParam", | |
| "description": "getProperties-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/GetPropertiesParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/GetPropertiesResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/getProperty": { | |
| "post": { | |
| "description": "Liefert die Properties zu einem Gerät.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "getPropertyParam", | |
| "description": "getProperty-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/GetPropertyParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/GetPropertyResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/cancelTransaction": { | |
| "post": { | |
| "description": "Bricht eine laufende Transaction ab.\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "cancelTransactionParam", | |
| "description": "cancelTransaction-Parameter", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/cancelTransactionParam" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/cancelTransactionResponse" | |
| } | |
| }, | |
| "400": { | |
| "description": "Unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/SvcError" | |
| } | |
| }, | |
| "401": { | |
| "description": "Forbidden - Invalid SystemToken" | |
| }, | |
| "500": { | |
| "description": "ServerError" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "SystemTokenParam": { | |
| "type": "object", | |
| "required": [ | |
| "ssmsUser", | |
| "ssmsPassword" | |
| ], | |
| "properties": { | |
| "ssmsUser": { | |
| "type": "string", | |
| "description": "User des SSMS-Webservices inkl. dem Tenant, z.B. user@tenant." | |
| }, | |
| "ssmsPassword": { | |
| "type": "string", | |
| "description": "Passwort des SSMS-Webservices" | |
| } | |
| } | |
| }, | |
| "SystemTokenResponse": { | |
| "type": "object", | |
| "required": [ | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "systemToken": { | |
| "type": "string", | |
| "description": "System-Token" | |
| } | |
| } | |
| }, | |
| "LoginParams": { | |
| "type": "object", | |
| "required": [ | |
| "certHandle", | |
| "pushNotification", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "certHandle": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Username" | |
| }, | |
| "pushNotification": { | |
| "type": "boolean", | |
| "description": "Sendet eine Push-Notification, wenn kein Gerät online ist." | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "LoginBasicParams": { | |
| "type": "object", | |
| "required": [ | |
| "userId", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "LoginBasicResult": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "LoginSignParam": { | |
| "type": "object", | |
| "required": [ | |
| "deviceGoOnlineTimeout", | |
| "pinEntryRequired", | |
| "timeoutSeconds", | |
| "requiresUserConfirmation", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "deviceGoOnlineTimeout": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "deviceId": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "portalId": { | |
| "type": "string" | |
| }, | |
| "transactionId": { | |
| "type": "boolean" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "entryItems": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SimpleEntryItem" | |
| } | |
| }, | |
| "displayData": { | |
| "type": "string" | |
| }, | |
| "pushNotificationMessage": { | |
| "type": "string" | |
| }, | |
| "templateName": { | |
| "type": "string" | |
| }, | |
| "infoText": { | |
| "type": "string" | |
| }, | |
| "pinEntryRequired": { | |
| "type": "boolean" | |
| }, | |
| "requiresUserConfirmation": { | |
| "type": "boolean" | |
| }, | |
| "timeoutSeconds": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "LoginSignResponse": { | |
| "type": "object", | |
| "properties": { | |
| "returnCode": { | |
| "type": "string", | |
| "enum" : [ | |
| "OK", | |
| "OK_IN_WAITING_LIST", | |
| "GENERAL_ERROR", | |
| "FILTER_INVALID", | |
| "OTP_INVALID", | |
| "PARAMETER_MISSING", | |
| "PARAMETER_INVALID", | |
| "NO_CERT_FOR_USERID", | |
| "NO_CERT_FOR_CERTHANDLE", | |
| "CERT_IS_LOCKED", | |
| "USER_IS_LOCKED", | |
| "USER_INVALID", | |
| "CERT_IS_OFFLINE", | |
| "TRANSACTION_PENDING", | |
| "INVALID_ACTIVATION_NOT_AFTER", | |
| "ACTIVATION_NOT_AFTER_HAS_EXPIRED", | |
| "NO_TRANSACTION_RESULT", | |
| "NO_SESSION", | |
| "USERID_INVALID", | |
| "LOCK_REASON_INVALID", | |
| "USER_NOT_FOUND", | |
| "ACTIVATION_TIME_INVALID", | |
| "ISSUERDN_INVALID", | |
| "SERIAL_NUMBER_INVALID", | |
| "REQUESTED_CERTIFICATE_NOT_FOUND", | |
| "ACTIVATION_CODE_INVALID", | |
| "ENTITY_HAS_CHANGED", | |
| "DEVICE_DELETION_FAILED", | |
| "CERTIFICATE_DELETION_PROHIBITED", | |
| "NO_DEVICE_FOR_CERTHANDLE", | |
| "NO_USER_FOR_CERTHANDLE", | |
| "SEND_FAILED", | |
| "NO_DEVICE_FOR_USERID", | |
| "DEVICE_NOT_LOGGED_IN", | |
| "DEVICE_PROPERTY_INVALID", | |
| "DEVICE_ID_INVALID", | |
| "KEY_INVALID", | |
| "FLAG_INVALID", | |
| "TYPE_INVALID", | |
| "BINARY_VALUE_INVALID", | |
| "COUNTER_INVALID", | |
| "REQUESTED_DEVICE_PROPERTY_NOT_FOUND", | |
| "UNIQUE_PROPERTY_ALREADY_EXIST", | |
| "PROPERTY_READ_ONLY", | |
| "TRANSACTION_TEMPLATE_ERROR", | |
| "TRANSACTION_IN_WAITING_LIST", | |
| "TRANSACTION_PARAM_INVALID", | |
| "PIN_NOT_MINIMUM_LENGTH", | |
| "LANGUAGE_CODE_INVALID", | |
| "ID_TYPE_DOES_NOT_MATCH_OWNER", | |
| "UNKNOWN_OWNER_TYPE", | |
| "UNSUPPORTED_PROPERTY_OWNER", | |
| "GROUP_DOES_NOT_EXIST", | |
| "USER_DOES_NOT_EXIST", | |
| "PROPERTY_IS_READONLY", | |
| "REQUESTED_PROPERTY_NOT_FOUND", | |
| "IN_WAITING_LIST_DEVICE_NODE_COULD_NOT_BE_INFORMED", | |
| "HANDLED_BY_OTHER_NODE", | |
| "IN_WAITING_LIST_NOT_HANDLED_BY_OTHER_NODE", | |
| "HANDLING_FAILED", | |
| "DEVICE_ACTIVE_NODE_UNKNOWN", | |
| "REMOVED_FROM_WAITING_LIST_DEVICE_NODE_COULD_NOT_BE_INFORMED", | |
| "IN_MULTIPLE_TRANSACTIONS_MODE_NOT_ALLOWED", | |
| "NO_SESSIONID_FOR_NONCE", | |
| "INVALID_CHARACTERS", | |
| "OFFLINE_RE_SYNC_PARAM_INVALID", | |
| "ATC_INVALID", | |
| "NONCE_NOT_PERSISTED", | |
| "PUSH_NOTIFICATION_PARAM_INVALID", | |
| "PUSH_NOTIFICATION_MESSAGE_INVALID", | |
| "TEMPLATE_VARIABLES_INVALID", | |
| "PROPERTY_INVALID", | |
| "PROPERTY_FLAG_MUST_NOT_CHANGE", | |
| "WRONG_PIN", | |
| "NO_PIN_SET" | |
| ] | |
| } | |
| } | |
| }, | |
| "LoginOfflineOTPParams": { | |
| "type": "object", | |
| "required": [ | |
| "userId", | |
| "challenge", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "challenge": { | |
| "type": "string" | |
| }, | |
| "otp": { | |
| "type": "string" | |
| }, | |
| "sessionId": { | |
| "type": "string" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "LoginOfflineOTPResult": { | |
| "type": "object", | |
| "properties": { | |
| "lockTime": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "remainingRetries": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "loginResultCode": { | |
| "type": "string", | |
| "enum": [ | |
| "OK", | |
| "VERIFY_FAILED", | |
| "NOT_SUPPORTED", | |
| "NO_MORE_RETRIES", | |
| "TEMPORARY_LOCKED", | |
| "SECURE_SEQUENCE_FAILED_OTP1", | |
| "SECURE_SEQUENCE_FAILED_OTP2", | |
| "SECURE_SEQUENCE_FAILED_OTP3", | |
| "SECURE_SEQUENCE_FAILED_OTP4", | |
| "SECURE_SEQUENCE_FAILED_TIME" | |
| ] | |
| } | |
| } | |
| }, | |
| "OtpLoginParams": { | |
| "type": "object", | |
| "required": [ | |
| "otp", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "otp": { | |
| "type": "string", | |
| "description": "Otp" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "LoginResult": { | |
| "type": "object", | |
| "required": [ | |
| "certHandle", | |
| "softwareCertificate" | |
| ], | |
| "properties": { | |
| "certHandle": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "loginResultCode": { | |
| "type": "string", | |
| "enum": [ | |
| "LOGINOTP_UNKNOWN", | |
| "LOGINOTP_TIMED_OUT", | |
| "CERT_KNOWN_BUT_NOT_MAPPED_TO_USER", | |
| "CERT_MAPPED_BUT_LOCKED", | |
| "SOFTWARE_CERT_MAPPED_TO_USER", | |
| "HARDWARE_CERT_MAPPED_TO_USER", | |
| "DEVICETYPE_INVALID", | |
| "LOGINOTP_NOT_VERIFIED", | |
| "CERT_IS_OFFLINE", | |
| "LOGIN_WITH_CERT_FAILED" | |
| ] | |
| }, | |
| "nodeID": { | |
| "type": "string" | |
| }, | |
| "softwareCertificate": { | |
| "type": "boolean" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "LoginQrcodeParams": { | |
| "type": "object", | |
| "required": [ | |
| "portalSessionId", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "portalSessionId": { | |
| "type": "string" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "LoginQrcodeResult": { | |
| "type": "object", | |
| "properties": { | |
| "return": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "GetDevicesParams": { | |
| "description": "GetDevicesParams", | |
| "type": "object", | |
| "required": [ | |
| "userId", | |
| "certTypeCategory", | |
| "onlyOnlineCerts", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "certTypeCategory": { | |
| "type": "string", | |
| "enum": [ | |
| "HARDWARE", | |
| "SOFTWARE", | |
| "BOTH" | |
| ] | |
| }, | |
| "onlyOnlineCerts": { | |
| "type": "boolean" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "DevicesStateInfo": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DeviceStateInfo" | |
| } | |
| }, | |
| "DeviceStateInfo": { | |
| "type": "object", | |
| "properties": { | |
| "certHandle": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "deviceState": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "OFFLINE" | |
| ] | |
| }, | |
| "locked": { | |
| "type": "boolean" | |
| }, | |
| "nodeID": { | |
| "type": "string" | |
| }, | |
| "serialNumber": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "AddUserParams": { | |
| "description": "AddUserParams", | |
| "type": "object", | |
| "required": [ | |
| "userId", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "AddUserResponse": { | |
| "description": "AddUserResponse", | |
| "type": "object", | |
| "required": [ | |
| "return" | |
| ], | |
| "properties": { | |
| "return": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "RemoveUserParams": { | |
| "description": "RemoveUserParams", | |
| "type": "object", | |
| "required": [ | |
| "userId", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "RemoveUserResponse": { | |
| "description": "RemoveUserResponse", | |
| "type": "object", | |
| "required": [ | |
| "return" | |
| ], | |
| "properties": { | |
| "return": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "PushNotificationParam": { | |
| "type": "object", | |
| "required": [ | |
| "deviceId", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "deviceId": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "pushNotificationMessage": { | |
| "type": "string" | |
| }, | |
| "pushNotificationPayload": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SimpleEntryItem" | |
| } | |
| }, | |
| "templateVariables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SimpleEntryItem" | |
| } | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "LogOffDeviceParam": { | |
| "type": "object", | |
| "required": [ | |
| "certHandle", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "certHandle": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "LogOffUserParam": { | |
| "type": "object", | |
| "required": [ | |
| "userId", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "LogOffUserResponse": { | |
| "type": "object", | |
| "properties": { | |
| "return": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "SimpleEntryItem": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ActivationCodeParam": { | |
| "type": "object", | |
| "required": [ | |
| "userId", | |
| "secret", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "activationCode": { | |
| "type": "string" | |
| }, | |
| "activationNotAfter": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "info": { | |
| "type": "string" | |
| }, | |
| "secret": { | |
| "type": "boolean" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "ActivationCodeResponse": { | |
| "type": "object", | |
| "properties": { | |
| "activationCode": { | |
| "type": "string" | |
| }, | |
| "activationNotAfter": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "creationDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "info": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "qrcodeContentType": { | |
| "type": "string" | |
| }, | |
| "qrcodeBase64": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "GetActivationCodeParam": { | |
| "type": "object", | |
| "required": [ | |
| "userId", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "GetActivationCodeResponse": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ActivationCodeResponse" | |
| } | |
| }, | |
| "StartTransactionParam": { | |
| "type": "object", | |
| "required": [ | |
| "deviceGoOnlineTimeout", | |
| "deviceId", | |
| "pinEntryRequired", | |
| "timeoutSeconds", | |
| "requiresUserConfirmation", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "deviceGoOnlineTimeout": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "deviceId": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "portalId": { | |
| "type": "string" | |
| }, | |
| "transactionId": { | |
| "type": "boolean" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "entryItems": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SimpleEntryItem" | |
| } | |
| }, | |
| "displayData": { | |
| "type": "string" | |
| }, | |
| "pushNotificationMessage": { | |
| "type": "string" | |
| }, | |
| "templateName": { | |
| "type": "string" | |
| }, | |
| "infoText": { | |
| "type": "string" | |
| }, | |
| "pinEntryRequired": { | |
| "type": "boolean" | |
| }, | |
| "requiresUserConfirmation": { | |
| "type": "boolean" | |
| }, | |
| "timeoutSeconds": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "StartTransactionResponse": { | |
| "type": "object", | |
| "properties": { | |
| "returnCode": { | |
| "type": "string", | |
| "enum" : [ | |
| "OK", | |
| "OK_IN_WAITING_LIST", | |
| "GENERAL_ERROR", | |
| "FILTER_INVALID", | |
| "OTP_INVALID", | |
| "PARAMETER_MISSING", | |
| "PARAMETER_INVALID", | |
| "NO_CERT_FOR_USERID", | |
| "NO_CERT_FOR_CERTHANDLE", | |
| "CERT_IS_LOCKED", | |
| "USER_IS_LOCKED", | |
| "USER_INVALID", | |
| "CERT_IS_OFFLINE", | |
| "TRANSACTION_PENDING", | |
| "INVALID_ACTIVATION_NOT_AFTER", | |
| "ACTIVATION_NOT_AFTER_HAS_EXPIRED", | |
| "NO_TRANSACTION_RESULT", | |
| "NO_SESSION", | |
| "USERID_INVALID", | |
| "LOCK_REASON_INVALID", | |
| "USER_NOT_FOUND", | |
| "ACTIVATION_TIME_INVALID", | |
| "ISSUERDN_INVALID", | |
| "SERIAL_NUMBER_INVALID", | |
| "REQUESTED_CERTIFICATE_NOT_FOUND", | |
| "ACTIVATION_CODE_INVALID", | |
| "ENTITY_HAS_CHANGED", | |
| "DEVICE_DELETION_FAILED", | |
| "CERTIFICATE_DELETION_PROHIBITED", | |
| "NO_DEVICE_FOR_CERTHANDLE", | |
| "NO_USER_FOR_CERTHANDLE", | |
| "SEND_FAILED", | |
| "NO_DEVICE_FOR_USERID", | |
| "DEVICE_NOT_LOGGED_IN", | |
| "DEVICE_PROPERTY_INVALID", | |
| "DEVICE_ID_INVALID", | |
| "KEY_INVALID", | |
| "FLAG_INVALID", | |
| "TYPE_INVALID", | |
| "BINARY_VALUE_INVALID", | |
| "COUNTER_INVALID", | |
| "REQUESTED_DEVICE_PROPERTY_NOT_FOUND", | |
| "UNIQUE_PROPERTY_ALREADY_EXIST", | |
| "PROPERTY_READ_ONLY", | |
| "TRANSACTION_TEMPLATE_ERROR", | |
| "TRANSACTION_IN_WAITING_LIST", | |
| "TRANSACTION_PARAM_INVALID", | |
| "PIN_NOT_MINIMUM_LENGTH", | |
| "LANGUAGE_CODE_INVALID", | |
| "ID_TYPE_DOES_NOT_MATCH_OWNER", | |
| "UNKNOWN_OWNER_TYPE", | |
| "UNSUPPORTED_PROPERTY_OWNER", | |
| "GROUP_DOES_NOT_EXIST", | |
| "USER_DOES_NOT_EXIST", | |
| "PROPERTY_IS_READONLY", | |
| "REQUESTED_PROPERTY_NOT_FOUND", | |
| "IN_WAITING_LIST_DEVICE_NODE_COULD_NOT_BE_INFORMED", | |
| "HANDLED_BY_OTHER_NODE", | |
| "IN_WAITING_LIST_NOT_HANDLED_BY_OTHER_NODE", | |
| "HANDLING_FAILED", | |
| "DEVICE_ACTIVE_NODE_UNKNOWN", | |
| "REMOVED_FROM_WAITING_LIST_DEVICE_NODE_COULD_NOT_BE_INFORMED", | |
| "IN_MULTIPLE_TRANSACTIONS_MODE_NOT_ALLOWED", | |
| "NO_SESSIONID_FOR_NONCE", | |
| "INVALID_CHARACTERS", | |
| "OFFLINE_RE_SYNC_PARAM_INVALID", | |
| "ATC_INVALID", | |
| "NONCE_NOT_PERSISTED", | |
| "PUSH_NOTIFICATION_PARAM_INVALID", | |
| "PUSH_NOTIFICATION_MESSAGE_INVALID", | |
| "TEMPLATE_VARIABLES_INVALID", | |
| "PROPERTY_INVALID", | |
| "PROPERTY_FLAG_MUST_NOT_CHANGE", | |
| "WRONG_PIN", | |
| "NO_PIN_SET" | |
| ] | |
| } | |
| } | |
| }, | |
| "TransactionResultParam": { | |
| "type": "object", | |
| "required": [ | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "deviceId": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "transactionId": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| }, | |
| "userId": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "TransactionResultResponse": { | |
| "type": "object", | |
| "required": [ | |
| "deviceId" | |
| ], | |
| "properties": { | |
| "deviceId": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "resultCode": { | |
| "type": "string", | |
| "enum" : [ | |
| "OK", | |
| "CANCELLED_BY_USER", | |
| "USER_CONFIRMATION_TIMEOUT", | |
| "TRANSACTION_TIMED_OUT", | |
| "DEVICE_GO_ONLINE_TIMEOUT", | |
| "RESULT_REQUEST_TIMEOUT", | |
| "INVALID_PIN", | |
| "INVALID_PARAMETER", | |
| "FAILED_SIGNATURE_NOT_VERIFIED", | |
| "FAILED", | |
| "APP_DISCONNECTED", | |
| "TEMPLATE_RESOLUTION_FAILED", | |
| "TRANSACTION_TIMEOUT_RESULT_EVICTED" | |
| ] | |
| }, | |
| "signature": { | |
| "type": "string" | |
| }, | |
| "transactionId": { | |
| "type": "string" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "PollTransactionResultParam": { | |
| "type": "object", | |
| "required": [ | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "PollTransactionResultResponse": { | |
| "type": "object", | |
| "properties": { | |
| "return": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| } | |
| }, | |
| "DeviceInfoParam": { | |
| "type": "object", | |
| "required": [ | |
| "certHandle", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "certHandle": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Username" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "DeviceInfoResponse": { | |
| "type": "object", | |
| "required": [ | |
| "certHandle", | |
| "locked", | |
| "userLocked" | |
| ], | |
| "properties": { | |
| "certHandle": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Username" | |
| }, | |
| "deviceState": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "OFFLINE" | |
| ] | |
| }, | |
| "locked": { | |
| "type": "boolean" | |
| }, | |
| "nodeID": { | |
| "type": "string" | |
| }, | |
| "serialNumber": { | |
| "type": "string" | |
| }, | |
| "appName": { | |
| "type": "string" | |
| }, | |
| "appVersion": { | |
| "type": "string" | |
| }, | |
| "clientDevice": { | |
| "type": "string" | |
| }, | |
| "clientOsVersion": { | |
| "type": "string" | |
| }, | |
| "clientRisks": { | |
| "type": "string" | |
| }, | |
| "clientTypeName": { | |
| "type": "string" | |
| }, | |
| "deviceType": { | |
| "type": "string" | |
| }, | |
| "deviceTypeName": { | |
| "type": "string" | |
| }, | |
| "deviceVersion": { | |
| "type": "string" | |
| }, | |
| "issuerDN": { | |
| "type": "string" | |
| }, | |
| "lastLoginTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "lockReasonKey": { | |
| "type": "string" | |
| }, | |
| "lockedUntilDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "userLocked": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "LockDeviceParam": { | |
| "type": "object", | |
| "required": [ | |
| "deviceID", | |
| "lockReason", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "deviceID": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Username" | |
| }, | |
| "lockReason": { | |
| "type": "string", | |
| "description": "Lock-Reason" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "LockDeviceResponse": { | |
| "type": "object", | |
| "required": [ | |
| "return" | |
| ], | |
| "properties": { | |
| "return": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "UnlockDeviceParam": { | |
| "type": "object", | |
| "required": [ | |
| "deviceID", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "deviceID": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Username" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "UnlockDeviceResponse": { | |
| "type": "object", | |
| "required": [ | |
| "return" | |
| ], | |
| "properties": { | |
| "return": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "GetPropertiesParam": { | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "owner", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "expiresOn": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "description": "Can be anyType" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "owner": { | |
| "type": "string", | |
| "enum": [ | |
| "OWNER_DEVICE", | |
| "OWNER_USER", | |
| "OWNER_GROUP" | |
| ] | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "GetPropertiesResponse": { | |
| "type": "object", | |
| "required": [ | |
| "flags", | |
| "id", | |
| "key", | |
| "owner" | |
| ], | |
| "properties": { | |
| "binaryValue": { | |
| "type": "string", | |
| "description": "value is base64 coded" | |
| }, | |
| "expiresOn": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "flags": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "id": { | |
| "description": "Can be anyType" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "owner": { | |
| "type": "string", | |
| "enum": [ | |
| "OWNER_DEVICE", | |
| "OWNER_USER", | |
| "OWNER_GROUP" | |
| ] | |
| }, | |
| "reportingDetails": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "GetPropertyParam": { | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "owner", | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "expiresOn": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "description": "Can be anyType" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "owner": { | |
| "type": "string", | |
| "enum": [ | |
| "OWNER_DEVICE", | |
| "OWNER_USER", | |
| "OWNER_GROUP" | |
| ] | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "GetPropertyResponse": { | |
| "type": "object", | |
| "required": [ | |
| "flags", | |
| "id", | |
| "key", | |
| "owner" | |
| ], | |
| "properties": { | |
| "binaryValue": { | |
| "type": "string", | |
| "description": "value is base64 coded" | |
| }, | |
| "expiresOn": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "flags": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "id": { | |
| "description": "Can be anyType" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "owner": { | |
| "type": "string", | |
| "enum": [ | |
| "OWNER_DEVICE", | |
| "OWNER_USER", | |
| "OWNER_GROUP" | |
| ] | |
| }, | |
| "reportingDetails": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "cancelTransactionParam": { | |
| "type": "object", | |
| "required": [ | |
| "systemToken" | |
| ], | |
| "properties": { | |
| "deviceId": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "transactionId": { | |
| "type": "string" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "reportDetails": { | |
| "type": "string" | |
| }, | |
| "systemToken": { | |
| "type": "string", | |
| "description": "SystemToken" | |
| } | |
| } | |
| }, | |
| "cancelTransactionResponse": { | |
| "type": "object", | |
| "properties": { | |
| "deviceId": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "transactionId": { | |
| "type": "string" | |
| }, | |
| "cancelResult": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION_NOT_FOUND", | |
| "TRANSACTION_DISCARDED_RESULT", | |
| "TRANSACTION_DISCARDED_FROM_CACHE", | |
| "TRANSACTION_DISCARDED_FROM_CLIENT", | |
| "TRANSACTION_REMOVED_FROM_WAITING_LIST" | |
| ] | |
| } | |
| } | |
| }, | |
| "MgtError": { | |
| "description": "Management-Fehlerobjekt", | |
| "type": "object", | |
| "properties": { | |
| "errorCode": { | |
| "type": "string", | |
| "enum": [ | |
| "PERMISSION_DENIED", | |
| "GENERAL_ERROR", | |
| "USERID_INVALID", | |
| "LOCK_REASON_INVALID", | |
| "USER_NOT_FOUND", | |
| "FILTER_INVALID", | |
| "ACTIVATION_TIME_INVALID", | |
| "ACTIVATION_TIME_HAS_EXPIRED", | |
| "ISSUERDN_INVALID", | |
| "SERIAL_NUMBER_INVALID", | |
| "REQUESTED_CERTIFICATE_NOT_FOUND", | |
| "ACTIVATION_CODE_INVALID", | |
| "DEVICE_ID_INVALID", | |
| "PARAMETER_INVALID", | |
| "GROUP_NAME_INVALID", | |
| "GROUP_NAME_NOT_START_WITH_AUTO_GROUP", | |
| "GROUP_ALREADY_EXIST", | |
| "GROUP_NOT_FOUND", | |
| "SET_AUTO_GROUP_NOT_ALLOWED", | |
| "USER_ALREADY_ASSIGNED_TO_GROUP", | |
| "USER_ALREADY_UNASSIGNED_FROM_GROUP", | |
| "STATISTIC_TYPE_INVALID", | |
| "STATISTIC_PARAMETERS_INVALID", | |
| "ACTIVATION_CODE_ALREADY_EXIST", | |
| "ACTIVATION_INFO_INVALID", | |
| "LANGUAGE_INVALID", | |
| "CONTENTS_INVALID", | |
| "USER_PIN_NOT_CONFIGURED", | |
| "DEVICE_PARAMETER_INVALID", | |
| "ACTIVATION_TIME_EXCEED_MAX_DURATION", | |
| "ACTIVATION_CODE_LENGTH_INVALID", | |
| "PARAMETER_MISSING", | |
| "INVALID_CHARACTERS", | |
| "APP_BUNDLE_PARAM_INVALID", | |
| "INVALID_PIN_FOR_CA", | |
| "INVALID_PORT", | |
| "UNKNOWN_HOST", | |
| "CONNECTION_FAILED", | |
| "RETRIEVAL_CERT_CHAIN_FAILED", | |
| "VERSION_PARAM_INVALID", | |
| "SOFTWARE_TYPE_INVALID", | |
| "CLIENT_TYPE_INVALID", | |
| "DEVICE_TYPE_INVALID", | |
| "APP_NAME_INVALID", | |
| "VERSION_STR_INVALID", | |
| "INSTALLER_INVALID", | |
| "REQUESTED_VERSION_NOT_FOUND", | |
| "VERSION_DELETION_PROHIBITED", | |
| "VERSION_UPDATE_PARAM_INVALID", | |
| "MANDATORY_FROM_INVALID", | |
| "VERSION_UPDATE_WITH_NOT_NULL_VERSION_EXIST", | |
| "VERSION_UPDATE_WITH_NULL_VERSION_EXIST", | |
| "VERSION_UPDATE_NOT_FOUND", | |
| "PLATFORM_TYPE_INVALID", | |
| "VERSION_UPDATE_PROHIBITED", | |
| "VERSION_MANAGEMENT_PROHIBITED", | |
| "APP_NAME_ALREADY_EXIST_ON_ANY_TENANT", | |
| "APP_NAME_ALREADY_EXIST_ON_MASTER", | |
| "UNKNOWN_ERROR" | |
| ] | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SvcError": { | |
| "description": "Service-Fehlerobjekt", | |
| "type": "object", | |
| "properties": { | |
| "errorCode": { | |
| "type": "string", | |
| "enum": [ | |
| "OK", | |
| "OK_IN_WAITING_LIST", | |
| "GENERAL_ERROR", | |
| "FILTER_INVALID", | |
| "OTP_INVALID", | |
| "PARAMETER_MISSING", | |
| "PARAMETER_INVALID", | |
| "NO_CERT_FOR_USERID", | |
| "NO_CERT_FOR_CERTHANDLE", | |
| "CERT_IS_LOCKED", | |
| "USER_IS_LOCKED", | |
| "USER_INVALID", | |
| "CERT_IS_OFFLINE", | |
| "TRANSACTION_PENDING", | |
| "INVALID_ACTIVATION_NOT_AFTER", | |
| "ACTIVATION_NOT_AFTER_HAS_EXPIRED", | |
| "NO_TRANSACTION_RESULT", | |
| "NO_SESSION", | |
| "USERID_INVALID", | |
| "LOCK_REASON_INVALID", | |
| "USER_NOT_FOUND", | |
| "ACTIVATION_TIME_INVALID", | |
| "ISSUERDN_INVALID", | |
| "SERIAL_NUMBER_INVALID", | |
| "REQUESTED_CERTIFICATE_NOT_FOUND", | |
| "ACTIVATION_CODE_INVALID", | |
| "ENTITY_HAS_CHANGED", | |
| "DEVICE_DELETION_FAILED", | |
| "CERTIFICATE_DELETION_PROHIBITED", | |
| "NO_DEVICE_FOR_CERTHANDLE", | |
| "NO_USER_FOR_CERTHANDLE", | |
| "SEND_FAILED", | |
| "NO_DEVICE_FOR_USERID", | |
| "DEVICE_NOT_LOGGED_IN", | |
| "DEVICE_PROPERTY_INVALID", | |
| "DEVICE_ID_INVALID", | |
| "KEY_INVALID", | |
| "FLAG_INVALID", | |
| "TYPE_INVALID", | |
| "BINARY_VALUE_INVALID", | |
| "COUNTER_INVALID", | |
| "REQUESTED_DEVICE_PROPERTY_NOT_FOUND", | |
| "UNIQUE_PROPERTY_ALREADY_EXIST", | |
| "PROPERTY_READ_ONLY", | |
| "TRANSACTION_TEMPLATE_ERROR", | |
| "TRANSACTION_IN_WAITING_LIST", | |
| "TRANSACTION_PARAM_INVALID", | |
| "PIN_NOT_MINIMUM_LENGTH", | |
| "LANGUAGE_CODE_INVALID", | |
| "ID_TYPE_DOES_NOT_MATCH_OWNER", | |
| "UNKNOWN_OWNER_TYPE", | |
| "UNSUPPORTED_PROPERTY_OWNER", | |
| "GROUP_DOES_NOT_EXIST", | |
| "USER_DOES_NOT_EXIST", | |
| "PROPERTY_IS_READONLY", | |
| "REQUESTED_PROPERTY_NOT_FOUND", | |
| "IN_WAITING_LIST_DEVICE_NODE_COULD_NOT_BE_INFORMED", | |
| "HANDLED_BY_OTHER_NODE", | |
| "IN_WAITING_LIST_NOT_HANDLED_BY_OTHER_NODE", | |
| "HANDLING_FAILED", | |
| "DEVICE_ACTIVE_NODE_UNKNOWN", | |
| "REMOVED_FROM_WAITING_LIST_DEVICE_NODE_COULD_NOT_BE_INFORMED", | |
| "IN_MULTIPLE_TRANSACTIONS_MODE_NOT_ALLOWED", | |
| "NO_SESSIONID_FOR_NONCE", | |
| "INVALID_CHARACTERS", | |
| "OFFLINE_RE_SYNC_PARAM_INVALID", | |
| "ATC_INVALID", | |
| "NONCE_NOT_PERSISTED", | |
| "PUSH_NOTIFICATION_PARAM_INVALID", | |
| "PUSH_NOTIFICATION_MESSAGE_INVALID", | |
| "TEMPLATE_VARIABLES_INVALID", | |
| "PROPERTY_INVALID", | |
| "PROPERTY_FLAG_MUST_NOT_CHANGE", | |
| "WRONG_PIN", | |
| "NO_PIN_SET", | |
| "UNKNOWN_ERROR" | |
| ] | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment