Boomi MFT - File Sharing API Reference (1.16) - ImmutableSessionByTicket

Toggle Pane

• ImmutableSessionByTicket
  • postCreate new Immutable Session object by Ticket

API docs by Redocly

Download OpenAPI Specification: Download

ImmutableSessionByTicket

The Immutable Session Ticket Authentication REST Web Service authenticates an MFT user by validating a provided authentication ticket and returns an immutable session token, allowing multiple concurrent sessions for the same user account.

Create new Immutable Session object by Ticket

Verify user credentials and authenticate MFT user in the system with immutable session

Remarks | Example request: UserName=admin&Password=password&
ClientVersion=1&ApplicationId=12 |

Request Body schema: application/x-www-form-urlencoded

required

Request body — Request type: ThruSessionRequest — Schema: ThruSessionRequest structure contains information required for the MFT user authentication.

ApplicationId required	string Application ID used by connecting application
ClientVersion required	string Version of the client application
Device\UUID required	string Limited by 17 characters
Password required	string Password of the user
UserName required	string Username of the user in the system
UserString	string Optional. External user information associated with the login session. Will be recorded in MFT Audit on each upload/download/delete API call. Limit 256 characters

Responses

https://{MFTWebServer}/REST/{version}/ImmutableSessionByTicket

Request samples

• Payload

Content type

application/x-www-form-urlencoded

ApplicationId=12&ClientVersion=1&Device%5CUUID=Device1234&Password=Password&UserName=Test&UserString=Name+%2F+email%40domain.com

Response samples

• 201

Content type

application/json

{

• "SessionID": "TOjoy3c1LyReUsXqXX/7u3+0qv FYXGArgsZ1k0OEGhIfwB2cd365+SCM8Rs5 JOLPMD/IJJSd2Jy7IXLl5t685kgRJo0Tr bup/VDN+25Lkenh387d4pXJzObepqO qusnnsA4de+5r4PHfdN0 9niJtsoSOjWZ6XlEN",
• "UserID": "315KQM487N2EV"

}