Boomi MFT - File Sharing API Reference (1.16) - Session
Download OpenAPI Specification: Download
The Regular Session Authentication REST Web Service verifies user credentials and authenticates an MFT user, returning a regular session token that terminates any previous sessions for the same account.
Create New Session Object
Verify user credentials and authenticate MFT user in the system. 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 | UserName=Test&Password=Password&ClientVersion=1&ApplicationId=12&Device_UUID=Device1234&UserString=User |
Invocation Scenarios
Verify customer credentials Authenticate customer
Remarks
UserName=Test&Password=Password&ClientVersion=1&ApplicationId=12&Device_UUID=Device1234&UserString=User
Request Body schema: application/x-www-form-urlencodedrequired
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
ApplicationId=12&ClientVersion=1&Device%5CUUID=Device1234&Password=Password&UserName=Test&UserString=Name+%2F+email%40domain.com
Response samples
- 201
{- "SessionID": "TOjoy3c1LyReUsXqXX/7u3+0qv FYXGArgsZ1k0OEGhIfwB2cd365+SCM8Rs5 JOLPMD/IJJSd2Jy7IXLl5t685kgRJo0Tr bup/VDN+25Lkenh387d4pXJzObepqO qusnnsA4de+5r4PHfdN0 9niJtsoSOjWZ6XlEN",
- "UserID": "315KQM487N2EV"
}