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

Download OpenAPI Specification: Download

ImmutableSession

The Immutable Session Authentication REST Web Service verifies user credentials and authenticates an MFT user, returning an immutable session token that allows multiple concurrent sessions for the same account. It also supports passing external user information through the UserString parameter for audit and tracking purposes.

Create new Immutable Session object

Verify user credentials and authenticate MFT user in the system with immutable session. Optionally passes external user information for audit purposes in UserString for the session opened. Device_UUID parameter is mandatory and can be set to any string.

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

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

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