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

Toggle Pane

• User Service
  • getRetrieve User Information
  • putUpdate password for the User

API docs by Redocly

Download OpenAPI Specification: Download

User Service

The User Account REST Web Services provide endpoints for managing information and credentials of the currently authenticated user.

Retrieve User Information

Get information about currently logged user.

Invocation Scenarios

Get information about user.

Authorizations:

SessionAuth

Responses

Response Schema: application/json

DateCreated required	string <date-time> User’s date create (UTC)
DateLastPasswordChanged required	string <date-time> The date of the last password modification
DateModified required	string <date-time> User’s last date modify (UTC)
Email required	string User’s e-mail address
FirstName required	string User’s first name
FullName required	string User’s full name
LastName required	string User’s last name
ModifiedByUserId required	string Identifier of the user that is modify the specified user
Name required	string User name that is used for sign-in in Thru
PasswordNeverExpires required	boolean Flag indicate is the user password is never expires
Role required	integer <int32> User’s role on Thru: None = 0, Guest = 1, Recipient = 2, Member = 3, Manager = 4, Administrator = 5, System = 6
UserId required	string Identifier of user in Thru
DomainUsername	string If user is in domain, this field represent it domain name
Phone	string User’s phone number
CompanyName	string Company name
CreatedByUserId	string Identifier of the user that is create the specified user

https://{MFTWebServer}/REST/{version}/User/Info

Response samples

• 200

Content type

application/json

{

• "UserId": "1Q1OBQWVHTROE",
• "Name": "admin",
• "DomainUsername": "string",
• "FirstName": "Ad",
• "LastName": "Test",
• "FullName": "Ad Test",
• "Email": "devnull@test.com",
• "Phone": "string",
• "CompanyName": "string",
• "Role": 5,
• "DateCreated": "/Date(1337174868567)/",
• "DateModified": "/Date(1351871161613)/",
• "CreatedByUserId": "string",
• "ModifiedByUserId": "2T5LRH8F1R2QK",
• "DateLastPasswordChanged": "/Date(1343838136630)/",
• "PasswordNeverExpires": true

}

Update password for the User

Set new password for the user.

Authorizations:

SessionAuth

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

required

Request body — Request type: ThruPasswordInfo — Schema: ThruPasswordInfo structure contains information that is required for password change.

ConfirmPassword required	string Confirmation of the New password field
NewPassword required	string New password that is required to set
OldPassword required	string Current user password

Responses

https://{MFTWebServer}/REST/{version}/User/Password

Request samples

• Payload

Content type

application/x-www-form-urlencoded

ConfirmPassword=%5Cpassword1&NewPassword=%5Cpassword1&OldPassword=password