Start Transaction

Using this API, transaction can be initiated for the given user.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/v3_user/{userId}/tms

note

This API is applicable only for SHIFT based installations.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body(*Required)

Field Name	Type	Description
*userId	String	The specified string value for a user to trigger the TMS transaction.
*data	MessageData	The data to send to the client(s).
appFilter	AppFilter	An optional filter for specific apps and/or platforms of the user.
*astClientIds	String	An explicit non-empty set of client IDs of the TMS is sent, Default: unset.
retrievalTimeout	Integer	The time in seconds clients have to retrieve the TMS, Default: 300.
tmsTimeout	Integer	The time in seconds that the clients have to answer to a TMS after retrieving it,Default: 600.
requireExplicitAuthentication	Boolean	Whether answering the TMS requires excplicit authentication, per default false.
requireFreshnessOfAuthentication	Integer	The maximum age in seconds of the access token used for answering the TMS is set Default: -1.
auditMessage	String	An optional message that is written as the audit detail message, default: unset.

Sample Request

      {
	"tmsData": {
		"text": "test TMS",
		"external": false,
		"data": {
			"origin": "KSA",
			"introduction1_en": "Lütfen işlem detaylarınızı kontrol edin",
			"authorizationHeader_en": "GİRİŞ DOĞRULAMA",
			"authorizationData_en": [{
				"key": "Kullanıcı Adı",
				"valueText": "TESTP SOYADTESTP"
			}],
			"dataSummary_en": [{
					"key": "Tarayıcı",
					"valueText": "Safari"
				},
				{
					"key": "IP",
					"valueText": "87.190.63.70"
				},
				{
					"key": "Tarih",
					"valueText": "2022-09-30T14:30:59.163Z"
				},
				{
					"key": "Token",
					"valueText": "zqYkNzSB"
				},
				{
					"key": "Web Sitesi",
					"valueText": "dummy.com"
				}
			],
			"introduction1_tr": "Lütfen işlem detaylarınızı kontrol edin",
			"authorizationHeader_tr": "GİRİŞ DOĞRULAMA",
			"authorizationData_tr": [{
				"key": "Kullanıcı Adı",
				"valueText": "TESTP SOYADTESTP"
			}],
			"dataSummary_tr": [{
					"key": "Tarayıcı",
					"valueText": "Safari"
				},
				{
					"key": "IP",
					"valueText": "87.190.63.70"
				},
				{
					"key": "Tarih",
					"valueText": "2022-09-30T14:30:59.163Z"
				},
				{
					"key": "Token",
					"valueText": "zqYkNzSB"
				},
				{
					"key": "Web Sitesi",
					"valueText": "dummy.com"
				}
			]
		}
	},
	"astClientIds": [
		"01GVJHZHJQHDMF6FETFKYYW8VT"
	],
	"retrievalTimeout": 50,
	"tmsTimeout": 40,
	"requireExplicitAuthentication": false,
	"requireFreshnessOfAuthentication": -1,
	"auditMessage": "test TMS auditMessage"
}

Response

Field Name	Type	Description
id	String	This denotes the ID of the transaction.
status	String	The status of the API call. Refer Response status Information for details.
startedAt	String	This explains the time the transaction started.
retrievalTimeout	Integer	The time in seconds clients have to retrieve the TMS, Default: 300.
tmsTimeout	Integer	The time in seconds that the clients have to answer to a TMS after retrieving it,Default: 600.
userId	String	The user's ID.
appFilter	AppFilter	An optional filter for specific apps and/or platforms of the user.
astClientIds	String	An explicit non-empty set of client IDs of the TMS is sent, Default: unset.

Sample Response

{
    "message": "Triggered tms successfully",
    "status": "OK",
    "subSystem": 2,
    "data": {
        "id": "01GQFRE72GZYXTFJ10W4C9Y8YP",
        "status": "STARTED",
        "startedAt": "2023*01*23T16:47:31.920900605Z",
        "retrievalTimeout": 50,
        "tmsTimeout": 50,
        "userId": "5b86b055*6644*4149*963d*01e5dd2072b6",
        "astClientIds": [
            "01GQFDATADK13BV8RCM1ZV2BMT"
        ]
    }
}

Response Status Information

Status Code	Status	Message
200	OK	Triggered tms successfully
400	BAD_REQUEST	Username should not be null or empty
401	Unauthorized	HTTP 401 Unauthorized