swagger: '2.0' info: version: 1.3.0-M32 title: Product IAPI APIs v1 contact: name: Monet+ url: 'http://www.monetplus.cz' host: '${BASE_URL}' basePath: /case-iapi tags: - name: case-iapi-rest-controller description: IAPI Rest Controller for CASE paths: /v1/accessCase: get: tags: - case-iapi-rest-controller summary: accessCase operationId: accessCaseUsingGET produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' responses: '200': description: OK schema: $ref: '#/definitions/AccessCaseResponse' deprecated: false /v1/activateInstance: post: tags: - case-iapi-rest-controller summary: activateInstance operationId: activateInstanceUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/ActivateInstanceRequest' responses: '200': description: OK schema: $ref: '#/definitions/ActivateInstanceResponse' deprecated: false /v1/activateMethod: post: tags: - case-iapi-rest-controller summary: activateMethod operationId: activateMethodUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/ActivateMethodRequest' responses: '200': description: OK schema: $ref: '#/definitions/ActivateMethodResponse' deprecated: false /v1/activationCode: post: tags: - case-iapi-rest-controller summary: getActivationCode operationId: getActivationCodeUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/GetActivationCodeRequest' responses: '200': description: OK schema: $ref: '#/definitions/GetActivationCodeResponse' deprecated: false /v1/blockInstance: post: tags: - case-iapi-rest-controller summary: blockInstance operationId: blockInstanceUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/BlockInstanceRequest' responses: '200': description: OK schema: $ref: '#/definitions/BlockInstanceResponse' deprecated: false /v1/blockMethod: post: tags: - case-iapi-rest-controller summary: blockMethod operationId: blockMethodUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/BlockMethodRequest' responses: '200': description: OK schema: $ref: '#/definitions/BlockMethodResponse' deprecated: false /v1/cancelTransaction: post: tags: - case-iapi-rest-controller summary: cancelTransaction operationId: cancelTransactionUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/CancelTransactionRequest' responses: '200': description: OK schema: $ref: '#/definitions/CancelTransactionResponse' deprecated: false /v1/deactivateInstance: post: tags: - case-iapi-rest-controller summary: deactivateInstance operationId: deactivateInstanceUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/DeactivateInstanceRequest' responses: '200': description: OK schema: $ref: '#/definitions/DeactivateInstanceResponse' deprecated: false /v1/deactivateMethod: post: tags: - case-iapi-rest-controller summary: deactivateMethod operationId: deactivateMethodUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/DeactivateMethodRequest' responses: '200': description: OK schema: $ref: '#/definitions/DeactivateMethodResponse' deprecated: false /v1/initiateInstance: post: tags: - case-iapi-rest-controller summary: initiateInstance operationId: initiateInstanceUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/InitiateInstanceRequest' responses: '200': description: OK schema: $ref: '#/definitions/InitiateInstanceResponse' deprecated: false /v1/initiateTransaction: post: tags: - case-iapi-rest-controller summary: initiateTransaction operationId: initiateTransactionUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/InitiateTransactionRequest' responses: '200': description: OK schema: $ref: '#/definitions/InitiateTransactionResponse' deprecated: false /v1/methodInfo: post: tags: - case-iapi-rest-controller summary: getMethodInfo operationId: getMethodInfoUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/GetMethodInfoRequest' responses: '200': description: OK schema: $ref: '#/definitions/GetMethodInfoResponse' deprecated: false /v1/methodParams: post: tags: - case-iapi-rest-controller summary: getMethodParams operationId: getMethodParamsUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/GetMethodParamsRequest' responses: '200': description: OK schema: $ref: '#/definitions/GetMethodParamsResponse' deprecated: false /v1/ping: get: tags: - case-iapi-rest-controller summary: ping operationId: pingUsingGET produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' responses: '200': description: OK schema: $ref: '#/definitions/IdportCaseResponse' deprecated: false /v1/setInstanceProperty: post: tags: - case-iapi-rest-controller summary: setInstanceProperty operationId: setInstancePropertyUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/SetInstancePropertyRequest' responses: '200': description: OK schema: $ref: '#/definitions/SetInstancePropertyResponse' deprecated: false /v1/transactionState: post: tags: - case-iapi-rest-controller summary: getTransactionState operationId: getTransactionStateUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/GetTransactionStateRequest' responses: '200': description: OK schema: $ref: '#/definitions/GetTransactionStateResponse' deprecated: false /v1/unblockInstance: post: tags: - case-iapi-rest-controller summary: unblockInstance operationId: unblockInstanceUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/UnblockInstanceRequest' responses: '200': description: OK schema: $ref: '#/definitions/UnblockInstanceResponse' deprecated: false /v1/unblockMethod: post: tags: - case-iapi-rest-controller summary: unblockMethod operationId: unblockMethodUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/UnblockMethodRequest' responses: '200': description: OK schema: $ref: '#/definitions/UnblockMethodResponse' deprecated: false /v1/verifyTransaction: post: tags: - case-iapi-rest-controller summary: verifyTransaction operationId: verifyTransactionUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-APP-SESSION-ID in: header required: false type: string x-example: 39b7a487-72e4-4b17-a653-05efb8a4376a - name: X-CHANNEL-ID in: header required: false type: string x-example: '1' - name: X-FORWARDED-FOR in: header required: false type: string x-example: 127.0.0.1 - name: X-SSO-SESSION-ID in: header required: false type: string x-example: 3f6d441c-7e3c-4f6b-b64e-22d43518179f - name: X-TRN-ID in: header required: false type: string x-example: '13485792783' - in: body name: req description: req required: true schema: $ref: '#/definitions/VerifyTransactionRequest' responses: '200': description: OK schema: $ref: '#/definitions/VerifyTransactionResponse' deprecated: false definitions: AccessCaseResponse: type: object properties: code: type: integer format: int32 data: type: object required: - tenant properties: list: type: array items: type: object required: - id - type properties: id: type: string type: type: string title: ComponentAccess tenant: type: string example: Monet+ title: AccessCaseResponse.Data message: type: string status: type: string enum: - success - fail - error title: AccessCaseResponse AccessCaseResponse.Data: type: object required: - tenant properties: list: type: array items: type: object required: - id - type properties: id: type: string type: type: string title: ComponentAccess tenant: type: string example: Monet+ title: AccessCaseResponse.Data ActivateInstanceRequest: type: object required: - instanceId - methodType - muid properties: instanceId: type: string example: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: ActivateInstanceRequest ActivateInstanceResponse: type: object properties: code: type: integer format: int32 data: type: object properties: instanceInfo: example: instanceId: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 state: ACTIVE instanceName: Swagger instance test name $ref: '#/definitions/InstanceInfo' title: ActivateInstanceResponse.Data message: type: string status: type: string enum: - success - fail - error title: ActivateInstanceResponse ActivateInstanceResponse.Data: type: object properties: instanceInfo: example: instanceId: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 state: ACTIVE instanceName: Swagger instance test name $ref: '#/definitions/InstanceInfo' title: ActivateInstanceResponse.Data ActivateMethodRequest: type: object required: - methodType - muid properties: methodSpecific: type: object example: algType: 2 methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: ActivateMethodRequest ActivateMethodResponse: type: object properties: code: type: integer format: int32 data: type: object properties: instanceInfo: type: object properties: activated: type: string format: date-time blocked: type: string format: date-time deactivated: type: string format: date-time instanceId: type: string instanceName: type: string lastAccess: type: string format: date-time state: type: string enum: - ACTIVE - BLOCKED_MAN - DEACTIVATED - EXPIRED - INITIATED validTo: type: string format: date-time title: InstanceInfo methodSpecific: example: algType: 2 salt: ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U= $ref: '#/definitions/ActivationProperties' title: ActivateMethodResponse.Data message: type: string status: type: string enum: - success - fail - error title: ActivateMethodResponse ActivateMethodResponse.Data: type: object properties: instanceInfo: type: object properties: activated: type: string format: date-time blocked: type: string format: date-time deactivated: type: string format: date-time instanceId: type: string instanceName: type: string lastAccess: type: string format: date-time state: type: string enum: - ACTIVE - BLOCKED_MAN - DEACTIVATED - EXPIRED - INITIATED validTo: type: string format: date-time title: InstanceInfo methodSpecific: example: algType: 2 salt: ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U= $ref: '#/definitions/ActivationProperties' title: ActivateMethodResponse.Data ActivationProperties: type: object properties: id: type: string title: ActivationProperties BlockInstanceRequest: type: object required: - instanceId - methodType - muid properties: instanceId: type: string example: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: BlockInstanceRequest BlockInstanceResponse: type: object properties: code: type: integer format: int32 message: type: string status: type: string enum: - success - fail - error title: BlockInstanceResponse BlockMethodRequest: type: object required: - methodType - muid properties: methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: BlockMethodRequest BlockMethodResponse: type: object properties: code: type: integer format: int32 message: type: string status: type: string enum: - success - fail - error title: BlockMethodResponse CancelTransactionRequest: type: object required: - caseId properties: caseId: type: string format: byte example: >- 41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf muid: type: string example: cg2t1 description: it is empty for the case of an anonymous transaction reason: type: string example: SWAGGER test tenant: type: string example: Monet+ title: CancelTransactionRequest CancelTransactionResponse: type: object properties: code: type: integer format: int32 message: type: string status: type: string enum: - success - fail - error title: CancelTransactionResponse Chap: type: object required: - authProtocol - challenge - response - username properties: authProtocol: type: integer format: int64 example: 1 challenge: type: string format: byte example: MzM5MjA1 response: type: string format: byte example: MzM5MjA1 username: type: string example: cg2t1 title: Chap Character: type: object title: Character ComponentAccess: type: object required: - id - type properties: id: type: string type: type: string title: ComponentAccess DeactivateInstanceRequest: type: object required: - instanceId - methodType - muid properties: instanceId: type: string example: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: DeactivateInstanceRequest DeactivateInstanceResponse: type: object properties: code: type: integer format: int32 message: type: string status: type: string enum: - success - fail - error title: DeactivateInstanceResponse DeactivateMethodRequest: type: object required: - methodType - muid properties: methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: DeactivateMethodRequest DeactivateMethodResponse: type: object properties: code: type: integer format: int32 message: type: string status: type: string enum: - success - fail - error title: DeactivateMethodResponse GetActivationCodeRequest: type: object required: - muid properties: muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: GetActivationCodeRequest GetActivationCodeResponse: type: object properties: code: type: integer format: int32 data: type: object properties: code: type: string example: 240537 qrData: type: string format: byte example: UVI1fDF8QTAzNDk0QkV8Y2cydDFAbW9uZXRwbHVzLmN6fDIzNzQyMQ== userId: type: string example: cg2t1@monetplus.cz title: GetActivationCodeResponse.Data message: type: string status: type: string enum: - success - fail - error title: GetActivationCodeResponse GetActivationCodeResponse.Data: type: object properties: code: type: string example: 240537 qrData: type: string format: byte example: UVI1fDF8QTAzNDk0QkV8Y2cydDFAbW9uZXRwbHVzLmN6fDIzNzQyMQ== userId: type: string example: cg2t1@monetplus.cz title: GetActivationCodeResponse.Data GetMethodInfoRequest: type: object required: - methodTypes - muid properties: methodTypes: type: array example: - PASSWORD items: type: string enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: GetMethodInfoRequest GetMethodInfoResponse: type: object properties: code: type: integer format: int32 data: type: object properties: methodInfo: type: array example: - methodType: PASSWORD state: ACTIVE activeInstances: 1 instances: - instanceId: >- 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 state: ACTIVE instanceName: Swagger instance test name - instanceId: >- 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3_2 state: INITIATED instanceName: Swagger instance test name_2 failedAttempts: 0 remainingAttempts: 3 items: type: object properties: activeInstances: type: integer format: int32 blockedUntil: type: string format: date-time failedAttempts: type: integer format: int32 instances: type: array items: type: object methodType: type: string enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT remainingAttempts: type: integer format: int32 state: type: string enum: - ACTIVE - BLOCKED_MAN - BLOCKED_USAGE_TEMP - BLOCKED_USAGE_PERM - DEACTIVATED title: MethodInfo title: GetMethodInfoResponse.Data message: type: string status: type: string enum: - success - fail - error title: GetMethodInfoResponse GetMethodInfoResponse.Data: type: object properties: methodInfo: type: array example: - methodType: PASSWORD state: ACTIVE activeInstances: 1 instances: - instanceId: >- 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 state: ACTIVE instanceName: Swagger instance test name - instanceId: >- 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3_2 state: INITIATED instanceName: Swagger instance test name_2 failedAttempts: 0 remainingAttempts: 3 items: type: object properties: activeInstances: type: integer format: int32 blockedUntil: type: string format: date-time failedAttempts: type: integer format: int32 instances: type: array items: type: object methodType: type: string enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT remainingAttempts: type: integer format: int32 state: type: string enum: - ACTIVE - BLOCKED_MAN - BLOCKED_USAGE_TEMP - BLOCKED_USAGE_PERM - DEACTIVATED title: MethodInfo title: GetMethodInfoResponse.Data GetMethodParamsRequest: type: object required: - methodType - muid properties: methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: GetMethodParamsRequest GetMethodParamsResponse: type: object properties: code: type: integer format: int32 data: type: object properties: methodSpecific: type: object example: algType: 2 salt: ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U= title: GetMethodParamsResponse.Data message: type: string status: type: string enum: - success - fail - error title: GetMethodParamsResponse GetMethodParamsResponse.Data: type: object properties: methodSpecific: type: object example: algType: 2 salt: ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U= title: GetMethodParamsResponse.Data GetTransactionStateRequest: type: object required: - caseId properties: caseId: type: string format: byte example: >- 41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf muid: type: string example: cg2t1 description: it is empty for the case of an anonymous transaction tenant: type: string example: Monet+ title: GetTransactionStateRequest GetTransactionStateResponse: type: object properties: code: type: integer format: int32 data: type: object required: - state properties: muid: type: string example: cg2t1 state: type: string example: INITIATED enum: - INITIATED - LOADED - EXPIRED - AUTHORIZED - FAILED - CANCELED title: GetTransactionStateResponse.Data message: type: string status: type: string enum: - success - fail - error title: GetTransactionStateResponse GetTransactionStateResponse.Data: type: object required: - state properties: muid: type: string example: cg2t1 state: type: string example: INITIATED enum: - INITIATED - LOADED - EXPIRED - AUTHORIZED - FAILED - CANCELED title: GetTransactionStateResponse.Data IdportCaseResponse: type: object title: IdportCaseResponse InitiateInstanceRequest: type: object required: - methodType - muid properties: methodSpecific: type: object description: depends on MethodType methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 name: type: string example: Swagger instance test name tenant: type: string example: Monet+ validTo: type: string format: date-time example: '2018-07-13T09:28:01Z' title: InitiateInstanceRequest InitiateInstanceResponse: type: object properties: code: type: integer format: int32 data: type: object required: - instanceInfo properties: instanceInfo: example: instanceId: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 state: ACTIVE instanceName: Swagger instance test name $ref: '#/definitions/InstanceInfo' title: InitiateInstanceResponse.Data message: type: string status: type: string enum: - success - fail - error title: InitiateInstanceResponse InitiateInstanceResponse.Data: type: object required: - instanceInfo properties: instanceInfo: example: instanceId: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 state: ACTIVE instanceName: Swagger instance test name $ref: '#/definitions/InstanceInfo' title: InitiateInstanceResponse.Data InitiateTransactionRequest: type: object required: - methodType properties: methodType: type: string example: PASSWORD enum: - PASSWORD - SMS - CM muid: type: string example: cg2t1 description: it is empty for the case of an anonymous transaction notificationDestination: type: string example: IAM operationType: type: string example: AUTHENTICATION enum: - AUTHENTICATION - AUTHORIZATION processingOptions: type: object properties: authorizationFlow: type: string example: ONLINE_OFFLINE enum: - ONLINE - OFFLINE - ONLINE_OFFLINE offlineChallenge: type: string example: QR enum: - QR - NONE - QR_NONE title: ProcessingOptions tenant: type: string example: Monet+ transactionData: type: object required: - data - locale - template properties: data: type: string format: byte example: >- U1RYMCVUUk5fSUQlJVRSTl9USU1FJVMwJENBU0VNb2JpbGUgdGVjaG5pY2FsIHRyYW5zYWN0aW9uJCo= locale: example: cs description: ISO 639-1 $ref: '#/definitions/Locale' template: type: string example: AUTHENTICATION title: TransactionData type: type: string example: PIN enum: - PIN - NO_PIN - INFORMATION_MESSAGE - ALT_SECRET_ACTIVATION validity: type: string format: date-time example: '2018-07-17T12:44:10.173Z' description: use the appropriate timestamp title: InitiateTransactionRequest InitiateTransactionResponse: type: object properties: code: type: integer format: int32 data: type: object required: - caseId properties: caseId: type: string format: byte example: >- 41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf methodSpecific: type: object example: salt: ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U= cipherPublicKey: >- MIHfMA0GCSqGSIb3DQEBAQUAA4HNADCByQKBwQCbA+nA4Oyfe4OiFeYGRK8O02+q3ObJ3IZPhYw7SJ5ULhygpZNhIcL5X0c1c2/yHuVoD7PKmoguQUu5Jj5uRC2ovvC8+X+xPRfohrhw8IXQ/DJC8AqRifCCUWshL8qzA4NNzIDIcMG+gLstSHdcMt6+opQb7AemGPfKiWVYw8wsTI9omkfT5QeMWTGJjBD38DFTLzEua/E56lm4MKDM4rk2PxD0Va0h2aZG7T0F6RwqhM7YYLhbc9LVwr840U9/EfUCAwEAAQ== algType: 2 nonce: l9ned9tLn4hpytmcXjLS2hiYcs85iPDwM6Kx5QRxiPoNilzlAi8BoDxt7YJ/nQ1o title: InitiateTransactionResponse.Data message: type: string status: type: string enum: - success - fail - error title: InitiateTransactionResponse InitiateTransactionResponse.Data: type: object required: - caseId properties: caseId: type: string format: byte example: >- 41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf methodSpecific: type: object example: salt: ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U= cipherPublicKey: >- MIHfMA0GCSqGSIb3DQEBAQUAA4HNADCByQKBwQCbA+nA4Oyfe4OiFeYGRK8O02+q3ObJ3IZPhYw7SJ5ULhygpZNhIcL5X0c1c2/yHuVoD7PKmoguQUu5Jj5uRC2ovvC8+X+xPRfohrhw8IXQ/DJC8AqRifCCUWshL8qzA4NNzIDIcMG+gLstSHdcMt6+opQb7AemGPfKiWVYw8wsTI9omkfT5QeMWTGJjBD38DFTLzEua/E56lm4MKDM4rk2PxD0Va0h2aZG7T0F6RwqhM7YYLhbc9LVwr840U9/EfUCAwEAAQ== algType: 2 nonce: l9ned9tLn4hpytmcXjLS2hiYcs85iPDwM6Kx5QRxiPoNilzlAi8BoDxt7YJ/nQ1o title: InitiateTransactionResponse.Data InstanceInfo: type: object properties: activated: type: string format: date-time blocked: type: string format: date-time deactivated: type: string format: date-time instanceId: type: string instanceName: type: string lastAccess: type: string format: date-time state: type: string enum: - ACTIVE - BLOCKED_MAN - DEACTIVATED - EXPIRED - INITIATED validTo: type: string format: date-time title: InstanceInfo Locale: type: object properties: country: type: string displayCountry: type: string displayLanguage: type: string displayName: type: string displayScript: type: string displayVariant: type: string extensionKeys: type: array items: type: object title: Character iso3Country: type: string iso3Language: type: string language: type: string script: type: string unicodeLocaleAttributes: type: array items: type: string unicodeLocaleKeys: type: array items: type: string variant: type: string title: Locale MethodInfo: type: object properties: activeInstances: type: integer format: int32 blockedUntil: type: string format: date-time failedAttempts: type: integer format: int32 instances: type: array items: type: object methodType: type: string enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT remainingAttempts: type: integer format: int32 state: type: string enum: - ACTIVE - BLOCKED_MAN - BLOCKED_USAGE_TEMP - BLOCKED_USAGE_PERM - DEACTIVATED title: MethodInfo ProcessingOptions: type: object properties: authorizationFlow: type: string example: ONLINE_OFFLINE enum: - ONLINE - OFFLINE - ONLINE_OFFLINE offlineChallenge: type: string example: QR enum: - QR - NONE - QR_NONE title: ProcessingOptions SetInstancePropertyRequest: type: object required: - instanceId - methodType - muid properties: instanceId: type: string example: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 name: type: string example: Swagger instance test name tenant: type: string example: Monet+ validTo: type: string format: date-time example: '2018-07-13T09:28:01Z' title: SetInstancePropertyRequest SetInstancePropertyResponse: type: object properties: code: type: integer format: int32 message: type: string status: type: string enum: - success - fail - error title: SetInstancePropertyResponse TransactionData: type: object required: - data - locale - template properties: data: type: string format: byte example: >- U1RYMCVUUk5fSUQlJVRSTl9USU1FJVMwJENBU0VNb2JpbGUgdGVjaG5pY2FsIHRyYW5zYWN0aW9uJCo= locale: example: cs description: ISO 639-1 $ref: '#/definitions/Locale' template: type: string example: AUTHENTICATION title: TransactionData UnblockInstanceRequest: type: object required: - instanceId - methodType - muid properties: instanceId: type: string example: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: UnblockInstanceRequest UnblockInstanceResponse: type: object properties: code: type: integer format: int32 message: type: string status: type: string enum: - success - fail - error title: UnblockInstanceResponse UnblockMethodRequest: type: object required: - methodType - muid properties: methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: UnblockMethodRequest UnblockMethodResponse: type: object properties: code: type: integer format: int32 message: type: string status: type: string enum: - success - fail - error title: UnblockMethodResponse VerifyTransactionRequest: type: object required: - caseId - methodType - muid properties: caseId: type: string format: byte example: >- 41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf description: it is get from /initiateTransaction response chap: type: object required: - authProtocol - challenge - response - username properties: authProtocol: type: integer format: int64 example: 1 challenge: type: string format: byte example: MzM5MjA1 response: type: string format: byte example: MzM5MjA1 username: type: string example: cg2t1 title: Chap code: type: string example: >- kuxejDzuNbSh1z6VGzYqo7Bv90IpfRavzGfxBYN9yl6D549zaSawq6+Cb0RDQLUz+vpFCgPBMHs73AQO1TpkVCACO/XiDfAf6P2ad61pPlXN02+L6fARtxXcOqowuM5AdPQioV4Byo1/guSjsT/BGNL0MpIjw5NgMtpB5NNw24+2PYx+8lzZM25NPTNaylTJNXBiCL3kBV/p68hc2p4EDzSSRjgA0uTH1oNMIqyNXXPOFGCKU9RSylrBnwLpCUkq description: it is computed from /initiateTransaction response methodType: type: string example: PASSWORD enum: - PASSWORD - ACTIVATION_CODE - SMS - CM - SPNEGO - TLS_CLIENT muid: type: string example: cg2t1 tenant: type: string example: Monet+ title: VerifyTransactionRequest VerifyTransactionResponse: type: object properties: code: type: integer format: int32 data: type: object properties: instanceInfo: example: instanceId: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 state: ACTIVE instanceName: Swagger instance test name $ref: '#/definitions/InstanceInfo' method: example: - methodType: PASSWORD state: ACTIVE activeInstances: 1 instances: - instanceId: >- 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 state: ACTIVE instanceName: Swagger instance test name - instanceId: >- 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3_2 state: INITIATED instanceName: Swagger instance test name_2 failedAttempts: 0 remainingAttempts: 3 $ref: '#/definitions/MethodInfo' title: VerifyTransactionResponse.Data message: type: string status: type: string enum: - success - fail - error title: VerifyTransactionResponse VerifyTransactionResponse.Data: type: object properties: instanceInfo: example: instanceId: 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 state: ACTIVE instanceName: Swagger instance test name $ref: '#/definitions/InstanceInfo' method: example: - methodType: PASSWORD state: ACTIVE activeInstances: 1 instances: - instanceId: >- 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3 state: ACTIVE instanceName: Swagger instance test name - instanceId: >- 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3_2 state: INITIATED instanceName: Swagger instance test name_2 failedAttempts: 0 remainingAttempts: 3 $ref: '#/definitions/MethodInfo' title: VerifyTransactionResponse.Data