Repository navigation
IAPI 1.3
Anezka Pejlova edited this page Nov 25, 2021
·
1 revision
Swagger YAML Version : 1.3.0-M32
Contact : Monet+
Host : ${BASE_URL}
BasePath : /
- case-iapi-rest-controller : IAPI Rest Controller for CASE
accessCase
GET /v1/accessCase
| Type | Name | Schema |
|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string |
| Header |
X-CHANNEL-ID optional |
string |
| Header |
X-FORWARDED-FOR optional |
string |
| Header |
X-SSO-SESSION-ID optional |
string |
| Header |
X-TRN-ID optional |
string |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccessCaseResponse |
application/json
- case-iapi-rest-controller
/v1/accessCase
"13485792783"{
"status": "success",
"data": {
"tenant": "idport",
"list": [
{
"id": "blockingRules",
"type": "readwrite"
},
{
"id": "blockMethod",
"type": "onbehalfof"
},
{
"id": "blockInstance",
"type": "onbehalfof"
},
{
"id": "deactivateMethod",
"type": "onbehalfof"
},
{
"id": "deactivateInstance",
"type": "onbehalfof"
},
{
"id": "initiateInstance",
"type": "onbehalfof"
},
{
"id": "setInstanceProperty",
"type": "onbehalfof"
},
{
"id": "getActivationCode",
"type": "onbehalfof"
},
{
"id": "activateInstance",
"type": "onbehalfof"
},
{
"id": "activateMethod",
"type": "onbehalfof"
},
{
"id": "unblockInstance",
"type": "onbehalfof"
},
{
"id": "unblockMethod",
"type": "onbehalfof"
},
{
"id": "getMethodInfo",
"type": "onbehalfof"
}
]
}
}activateInstance
POST /v1/activateInstance
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | ActivateInstanceRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ActivateInstanceResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/activateInstance
"13485792783"{
"instanceId": "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
"methodType": "PASSWORD",
"muid": "64728948",
"tenant": "Monet+"
}{
"data": {
"instanceInfo": {
"@type": "cz.monetplus.idport.component.model.InstanceInfo",
"instanceId": "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
"state": "ACTIVE",
"instanceName": "LGE LG-H440n"
}
},
"status": "success"
}activateMethod
POST /v1/activateMethod
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | ActivateMethodRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ActivateMethodResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/activateMethod
"13485792783"{
"methodSpecific" : {
"algType" : 2
},
"methodType" : "PASSWORD",
"muid" : "64728948",
"tenant" : "Monet+"
}{
"data": {
"methodSpecific": {
"@class": "cz.monetplus.idport.component.model.ActivationProperties$PwdMethodActivationProperties",
"algType": 2,
"salt": "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U="
}
},
"status": "success"
}getActivationCode
POST /v1/activationCode
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | GetActivationCodeRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GetActivationCodeResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/activationCode
"13485792783"{
"muid" : "64728948",
"tenant" : "Monet+"
}{
"data" : {
"code" : "240537",
"qrData" : "UVI1fDF8QTAzNDk0QkV8Y2cydDFAbW9uZXRwbHVzLmN6fDIzNzQyMQ==",
"userId" : "cg2t1@monetplus.cz"
},
"status" : "success"
}blockInstance
POST /v1/blockInstance
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | BlockInstanceRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BlockInstanceResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/blockInstance
"13485792783"{
"instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
"methodType" : "PASSWORD",
"muid" : "64728948",
"tenant" : "Monet+"
}{
"status" : "success"
}blockMethod
POST /v1/blockMethod
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | BlockMethodRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BlockMethodResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/blockMethod
"13485792783"{
"methodType" : "PASSWORD",
"muid" : "64728948",
"tenant" : "Monet+"
}{
"status" : "success"
}cancelTransaction
POST /v1/cancelTransaction
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | CancelTransactionRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CancelTransactionResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/cancelTransaction
"13485792783"{
"caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
"muid" : "64728948",
"reason" : "SWAGGER test",
"tenant" : "Monet+"
}{
"status" : "success"
}deactivateInstance
POST /v1/deactivateInstance
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | DeactivateInstanceRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DeactivateInstanceResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/deactivateInstance
"13485792783"{
"instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
"methodType" : "PASSWORD",
"muid" : "64728948",
"tenant" : "Monet+"
}{
"status" : "success"
}deactivateMethod
POST /v1/deactivateMethod
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | DeactivateMethodRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DeactivateMethodResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/deactivateMethod
"13485792783"{
"methodType" : "PASSWORD",
"muid" : "64728948",
"tenant" : "Monet+"
}{
"status" : "success"
}initiateInstance
POST /v1/initiateInstance
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | InitiateInstanceRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InitiateInstanceResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/initiateInstance
"13485792783"{
"methodSpecific": {
"value": "RDzNDcHmmvrE/qWKYQx0v494ZllOKwMaex+YNr1dpgs="
},
"methodType" : "PASSWORD",
"muid" : "64728948",
"name" : "Swagger instance test name",
"tenant" : "Monet+",
"validTo" : "2018-07-13T09:28:01Z"
}{
"data": {
"instanceInfo": {
"@type": "cz.monetplus.idport.component.model.InstanceInfo",
"instanceId": "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
"state": "ACTIVE",
"instanceName": "LGE LG-H440n"
}
},
"status": "success"
}initiateTransaction
POST /v1/initiateTransaction
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | InitiateTransactionRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InitiateTransactionResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/initiateTransaction
"13485792783"{
"methodType" : "PASSWORD",
"muid" : "cg2t1",
"notificationDestination" : "IAM",
"operationType" : "AUTHENTICATION",
"processingOptions" : {
"authorizationFlow" : "ONLINE_OFFLINE",
"offlineChallenge" : "QR"
},
"tenant" : "Monet+",
"transactionData" : {
"data" : "U1RYMCVUUk5fSUQlJVRSTl9USU1FJVMwJENBU0VNb2JpbGUgdGVjaG5pY2FsIHRyYW5zYWN0aW9uJCo=",
"locale" : "cs",
"template" : "AUTHENTICATION"
},
"type" : "PIN",
"validity" : "2018-07-17T12:44:10.173Z"
}{
"data": {
"caseId": "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
"encryptionHeader": {
"alg": "ECDH-ES",
"enc": "A256GCM",
"epk": {
"crv": "P-521",
"kid": "e482445b-9276-4dcd-b602-d55fa3c03d05",
"kty": "EC",
"x": "AImgIrUIo4jouXSYc6KDkGFrbCoVYN0bB9m7UmSW_32rIeQvbyKd2tke2YagMePvNm50lQyb4JHWBQXPgXq6Cgzx",
"y": "ALl3_-nmRaQIB8yNy09wP6WsbYJWsHRuJVOY40kXADjNDWzendO1E_gOR1gNr0J5W5aVMIbbWglRxt4XMl1t_PIT"
}
},
"expiration": {
"seconds": 600,
"timestamp": "2018-07-17T12:44:10.173Z"
},
"methodSpecific": {
"salt": "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U=",
"cipherPublicKey": "MIHfMA0GCSqGSIb3DQEBAQUAA4HNADCByQKBwQCbA+nA4Oyfe4OiFeYGRK8O02+q3ObJ3IZPhYw7SJ5ULhygpZNhIcL5X0c1c2/yHuVoD7PKmoguQUu5Jj5uRC2ovvC8+X+xPRfohrhw8IXQ/DJC8AqRifCCUWshL8qzA4NNzIDIcMG+gLstSHdcMt6+opQb7AemGPfKiWVYw8wsTI9omkfT5QeMWTGJjBD38DFTLzEua/E56lm4MKDM4rk2PxD0Va0h2aZG7T0F6RwqhM7YYLhbc9LVwr840U9/EfUCAwEAAQ==",
"algType": 2,
"nonce": "l9ned9tLn4hpytmcXjLS2hiYcs85iPDwM6Kx5QRxiPoNilzlAi8BoDxt7YJ/nQ1o"
}
},
"status": "success"
}getMethodInfo
POST /v1/methodInfo
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | GetMethodInfoRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GetMethodInfoResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/methodInfo
"13485792783"{
"methodTypes" : [ "PASSWORD" ],
"muid" : "cg2t1",
"tenant" : "Monet+"
}{
"data" : {
"methodInfo" : [ {
"methodType" : "PASSWORD",
"state" : "ACTIVE",
"activeInstances" : 1,
"instances" : [ {
"@type": "cz.monetplus.idport.component.model.InstanceInfo",
"instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
"state" : "ACTIVE",
"instanceName" : "LGE LG-H440n"
}, {
"instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3_2",
"state" : "INITIATED",
"instanceName" : "LGE LG-H440n_2"
} ],
"failedAttempts" : 0,
"remainingAttempts" : 3
} ]
},
"status" : "success"
}getMethodParams
POST /v1/methodParams
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | GetMethodParamsRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GetMethodParamsResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/methodParams
"13485792783"{
"methodType" : "PASSWORD",
"muid" : "cg2t1",
"tenant" : "Monet+"
}{
"data" : {
"methodSpecific" : { // this example is PASSWORD method specific
"algType" : 2,
"salt" : "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U="
"complexity": { // optional, based on method configuration
"minLength": 5,
"maxLength": 8,
"requiresDigits": true,
"requiresUppercaseLetters": true,
"requiresLowercaseLetters": true,
"requiresOtherCharacters": true
}
}
},
"status" : "success"
}ping
GET /v1/ping
| Type | Name | Schema |
|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string |
| Header |
X-CHANNEL-ID optional |
string |
| Header |
X-FORWARDED-FOR optional |
string |
| Header |
X-SSO-SESSION-ID optional |
string |
| Header |
X-TRN-ID optional |
string |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | IdportCaseResponse |
application/json
- case-iapi-rest-controller
/v1/ping
"13485792783"{
"status": "success",
"data": {
"details": [
{
"resource": "APP",
"code": 0,
"detail": {
"version": "1.3.0",
"module": "IDPORT - CASE IAPI Docker Module"
}
},
{
"resource": "DB",
"code": 0
},
{
"resource": "CASECore",
"code": 0
}
]
}
}setInstanceProperty
POST /v1/setInstanceProperty
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | SetInstancePropertyRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SetInstancePropertyResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/setInstanceProperty
"13485792783"{
"instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
"methodType" : "PASSWORD",
"muid" : "cg2t1",
"name" : "Swagger instance test name",
"tenant" : "Monet+",
"validTo" : "2018-07-13T09:28:01Z"
}{
"status" : "success"
}getTransactionState
POST /v1/transactionState
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | GetTransactionStateRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GetTransactionStateResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/transactionState
"13485792783"{
"caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
"muid" : "cg2t1",
"tenant" : "Monet+"
}{
"data" : {
"state" : "INITIATED"
},
"status" : "success"
}unblockInstance
POST /v1/unblockInstance
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | UnblockInstanceRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UnblockInstanceResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/unblockInstance
"13485792783"{
"instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
"methodType" : "PASSWORD",
"muid" : "cg2t1",
"tenant" : "Monet+"
}{
"status" : "success"
}unblockMethod
POST /v1/unblockMethod
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | UnblockMethodRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UnblockMethodResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/unblockMethod
"13485792783"{
"methodType" : "PASSWORD",
"muid" : "cg2t1",
"tenant" : "Monet+"
}{
"status" : "success"
}verifyTransaction
POST /v1/verifyTransaction
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
X-APP-SESSION-ID optional |
string | |
| Header |
X-CHANNEL-ID optional |
string | |
| Header |
X-FORWARDED-FOR optional |
string | |
| Header |
X-SSO-SESSION-ID optional |
string | |
| Header |
X-TRN-ID optional |
string | |
| Body |
req required |
req | VerifyTransactionRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VerifyTransactionResponse |
application/json
application/json
- case-iapi-rest-controller
/v1/verifyTransaction
"13485792783"{
"caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
"chap" : {
"authProtocol" : 1,
"challenge" : "MzM5MjA1",
"response" : "MzM5MjA1",
"username" : "cg2t1"
},
"code" : "kuxejDzuNbSh1z6VGzYqo7Bv90IpfRavzGfxBYN9yl6D549zaSawq6+Cb0RDQLUz+vpFCgPBMHs73AQO1TpkVCACO/XiDfAf6P2ad61pPlXN02+L6fARtxXcOqowuM5AdPQioV4Byo1/guSjsT/BGNL0MpIjw5NgMtpB5NNw24+2PYx+8lzZM25NPTNaylTJNXBiCL3kBV/p68hc2p4EDzSSRjgA0uTH1oNMIqyNXXPOFGCKU9RSylrBnwLpCUkq",
"methodType" : "PASSWORD",
"muid" : "cg2t1",
"tenant" : "Monet+"
}{
"data": {
"instanceInfo": {
"@type": "cz.monetplus.idport.component.model.InstanceInfo",
"instanceId": "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
"state": "ACTIVE",
"instanceName": "LGE LG-H440n",
"lastAccess": "2021-06-07T09:13:47.123758Z"
}
},
"status": "success"
}| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
data optional |
Example : "[accesscaseresponse-data](#accesscaseresponse-data)"
|
AccessCaseResponse.Data |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
list optional |
Example : [ "[componentaccess](#componentaccess)" ]
|
< ComponentAccess > array |
|
tenant required |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
instanceId required |
Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3"
|
string |
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
data optional |
Example : "[activateinstanceresponse-data](#activateinstanceresponse-data)"
|
ActivateInstanceResponse.Data |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
instanceInfo optional |
Example : "[instanceinfo](#instanceinfo)"
|
InstanceInfo |
| Name | Description | Schema |
|---|---|---|
|
methodSpecific optional |
Example : {<br> "algType" : 2<br>}
|
object |
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
data optional |
Example : "[activatemethodresponse-data](#activatemethodresponse-data)"
|
ActivateMethodResponse.Data |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
instanceInfo optional |
Example : "[instanceinfo](#instanceinfo)"
|
InstanceInfo |
|
methodSpecific optional |
Example : "[activationproperties](#activationproperties)"
|
ActivationProperties |
| Name | Description | Schema |
|---|---|---|
|
id optional |
Example : "string"
|
string |
| Name | Description | Schema |
|---|---|---|
|
instanceId required |
Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3"
|
string |
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
caseId required |
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf"
|
string (byte) |
|
muid optional |
it is empty for the case of an anonymous transaction Example : "cg2t1"
|
string |
|
reason optional |
Example : "SWAGGER test"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
authProtocol required |
Example : 1
|
integer (int64) |
|
challenge required |
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" Example : "MzM5MjA1"
|
string (byte) |
|
response required |
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" Example : "MzM5MjA1"
|
string (byte) |
|
username required |
Example : "cg2t1"
|
string |
Type : object
| Name | Description | Schema |
|---|---|---|
|
id required |
Example : "string"
|
string |
|
type required |
Example : "string"
|
string |
| Name | Description | Schema |
|---|---|---|
|
instanceId required |
Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3"
|
string |
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
data optional |
Example : "[getactivationcoderesponse-data](#getactivationcoderesponse-data)"
|
GetActivationCodeResponse.Data |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : "240537"
|
string |
|
qrData optional |
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" Example : "UVI1fDF8QTAzNDk0QkV8Y2cydDFAbW9uZXRwbHVzLmN6fDIzNzQyMQ=="
|
string (byte) |
|
userId optional |
Example : "cg2t1@monetplus.cz"
|
string |
| Name | Description | Schema |
|---|---|---|
|
methodTypes required |
Example : [ "PASSWORD" ]
|
< enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) > array |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
data optional |
Example : "[getmethodinforesponse-data](#getmethodinforesponse-data)"
|
GetMethodInfoResponse.Data |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
methodInfo optional |
Example : [ {<br> "methodType" : "PASSWORD",<br> "state" : "ACTIVE",<br> "activeInstances" : 1,<br> "instances" : [ {<br> "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",<br> "state" : "ACTIVE",<br> "instanceName" : "Swagger instance test name"<br> }, {<br> "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3_2",<br> "state" : "INITIATED",<br> "instanceName" : "Swagger instance test name_2"<br> } ],<br> "failedAttempts" : 0,<br> "remainingAttempts" : 3<br>} ]
|
< MethodInfo > array |
| Name | Description | Schema |
|---|---|---|
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
data optional |
Example : "[getmethodparamsresponse-data](#getmethodparamsresponse-data)"
|
GetMethodParamsResponse.Data |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
methodSpecific optional |
Example : {<br> "algType" : 2,<br> "salt" : "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U="<br>}
|
object |
| Name | Description | Schema |
|---|---|---|
|
caseId required |
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf"
|
string (byte) |
|
muid optional |
it is empty for the case of an anonymous transaction Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
data optional |
Example : "[gettransactionstateresponse-data](#gettransactionstateresponse-data)"
|
GetTransactionStateResponse.Data |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
muid optional |
Example : "cg2t1"
|
string |
|
state required |
Example : "INITIATED"
|
enum (INITIATED, LOADED, EXPIRED, AUTHORIZED, FAILED, CANCELED) |
Type : object
| Name | Description | Schema |
|---|---|---|
|
methodSpecific optional |
depends on MethodType Example : "object"
|
object |
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
name optional |
Example : "Swagger instance test name"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
|
validTo optional |
Example : "2018-07-13T09:28:01Z"
|
string (date-time) |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
data optional |
Example : "[initiateinstanceresponse-data](#initiateinstanceresponse-data)"
|
InitiateInstanceResponse.Data |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
instanceInfo required |
Example : "[instanceinfo](#instanceinfo)"
|
InstanceInfo |
| Name | Description | Schema |
|---|---|---|
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, SMS, CM) |
|
muid optional |
it is empty for the case of an anonymous transaction Example : "cg2t1"
|
string |
|
notificationDestination optional |
Example : "IAM"
|
string |
|
operationType optional |
Example : "AUTHENTICATION"
|
enum (AUTHENTICATION, AUTHORIZATION) |
|
processingOptions optional |
Example : "[processingoptions](#processingoptions)"
|
ProcessingOptions |
|
tenant optional |
Example : "Monet+"
|
string |
|
transactionData optional |
Example : "[transactiondata](#transactiondata)"
|
TransactionData |
|
type optional |
Example : "PIN"
|
enum (PIN, NO_PIN, INFORMATION_MESSAGE, ALT_SECRET_ACTIVATION) |
|
validity optional |
use the appropriate timestamp Example : "2018-07-17T12:44:10.173Z"
|
string (date-time) |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
data optional |
Example : "[initiatetransactionresponse-data](#initiatetransactionresponse-data)"
|
InitiateTransactionResponse.Data |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
caseId required |
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf"
|
string (byte) |
|
methodSpecific optional |
Example : {<br> "salt" : "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U=",<br> "cipherPublicKey" : "MIHfMA0GCSqGSIb3DQEBAQUAA4HNADCByQKBwQCbA+nA4Oyfe4OiFeYGRK8O02+q3ObJ3IZPhYw7SJ5ULhygpZNhIcL5X0c1c2/yHuVoD7PKmoguQUu5Jj5uRC2ovvC8+X+xPRfohrhw8IXQ/DJC8AqRifCCUWshL8qzA4NNzIDIcMG+gLstSHdcMt6+opQb7AemGPfKiWVYw8wsTI9omkfT5QeMWTGJjBD38DFTLzEua/E56lm4MKDM4rk2PxD0Va0h2aZG7T0F6RwqhM7YYLhbc9LVwr840U9/EfUCAwEAAQ==",<br> "algType" : 2,<br> "nonce" : "l9ned9tLn4hpytmcXjLS2hiYcs85iPDwM6Kx5QRxiPoNilzlAi8BoDxt7YJ/nQ1o"<br>}
|
object |
| Name | Description | Schema |
|---|---|---|
|
activated optional |
Example : "string"
|
string (date-time) |
|
blocked optional |
Example : "string"
|
string (date-time) |
|
deactivated optional |
Example : "string"
|
string (date-time) |
|
instanceId optional |
Example : "string"
|
string |
|
instanceName optional |
Example : "string"
|
string |
|
lastAccess optional |
Example : "string"
|
string (date-time) |
|
state optional |
Example : "string"
|
enum (ACTIVE, BLOCKED_MAN, DEACTIVATED, EXPIRED, INITIATED) |
|
validTo optional |
Example : "string"
|
string (date-time) |
| Name | Description | Schema |
|---|---|---|
|
country optional |
Example : "string"
|
string |
|
displayCountry optional |
Example : "string"
|
string |
|
displayLanguage optional |
Example : "string"
|
string |
|
displayName optional |
Example : "string"
|
string |
|
displayScript optional |
Example : "string"
|
string |
|
displayVariant optional |
Example : "string"
|
string |
|
extensionKeys optional |
Example : [ "[character](#character)" ]
|
< Character > array |
|
iso3Country optional |
Example : "string"
|
string |
|
iso3Language optional |
Example : "string"
|
string |
|
language optional |
Example : "string"
|
string |
|
script optional |
Example : "string"
|
string |
|
unicodeLocaleAttributes optional |
Example : [ "string" ]
|
< string > array |
|
unicodeLocaleKeys optional |
Example : [ "string" ]
|
< string > array |
|
variant optional |
Example : "string"
|
string |
| Name | Description | Schema |
|---|---|---|
|
activeInstances optional |
Example : 0
|
integer (int32) |
|
blockedUntil optional |
Example : "string"
|
string (date-time) |
|
failedAttempts optional |
Example : 0
|
integer (int32) |
|
instances optional |
Example : [ "object" ]
|
< object > array |
|
methodType optional |
Example : "string"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
remainingAttempts optional |
Example : 0
|
integer (int32) |
|
state optional |
Example : "string"
|
enum (ACTIVE, BLOCKED_MAN, BLOCKED_USAGE_TEMP, BLOCKED_USAGE_PERM, DEACTIVATED) |
| Name | Description | Schema |
|---|---|---|
|
authorizationFlow optional |
Example : "ONLINE_OFFLINE"
|
enum (ONLINE, OFFLINE, ONLINE_OFFLINE) |
|
offlineChallenge optional |
Example : "QR"
|
enum (QR, NONE, QR_NONE) |
| Name | Description | Schema |
|---|---|---|
|
instanceId required |
Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3"
|
string |
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
name optional |
Example : "Swagger instance test name"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
|
validTo optional |
Example : "2018-07-13T09:28:01Z"
|
string (date-time) |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
data required |
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" Example : "U1RYMCVUUk5fSUQlJVRSTl9USU1FJVMwJENBU0VNb2JpbGUgdGVjaG5pY2FsIHRyYW5zYWN0aW9uJCo="
|
string (byte) |
|
locale required |
ISO 639-1 Example : "[locale](#locale)"
|
Locale |
|
template required |
Example : "AUTHENTICATION"
|
string |
| Name | Description | Schema |
|---|---|---|
|
instanceId required |
Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3"
|
string |
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
caseId required |
it is get from /initiateTransaction response Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf"
|
string (byte) |
|
chap optional |
Example : "[chap](#chap)"
|
Chap |
|
code optional |
it is computed from /initiateTransaction response Example : "kuxejDzuNbSh1z6VGzYqo7Bv90IpfRavzGfxBYN9yl6D549zaSawq6+Cb0RDQLUz+vpFCgPBMHs73AQO1TpkVCACO/XiDfAf6P2ad61pPlXN02+L6fARtxXcOqowuM5AdPQioV4Byo1/guSjsT/BGNL0MpIjw5NgMtpB5NNw24+2PYx+8lzZM25NPTNaylTJNXBiCL3kBV/p68hc2p4EDzSSRjgA0uTH1oNMIqyNXXPOFGCKU9RSylrBnwLpCUkq"
|
string |
|
methodType required |
Example : "PASSWORD"
|
enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) |
|
muid required |
Example : "cg2t1"
|
string |
|
tenant optional |
Example : "Monet+"
|
string |
| Name | Description | Schema |
|---|---|---|
|
code optional |
Example : 0
|
integer (int32) |
|
data optional |
Example : "[verifytransactionresponse-data](#verifytransactionresponse-data)"
|
VerifyTransactionResponse.Data |
|
message optional |
Example : "string"
|
string |
|
status optional |
Example : "string"
|
enum (success, fail, error) |
| Name | Description | Schema |
|---|---|---|
|
instanceInfo optional |
Example : "[instanceinfo](#instanceinfo)"
|
InstanceInfo |
|
method optional |
Example : "[methodinfo](#methodinfo)"
|
MethodInfo |