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

Toggle Pane

• List Users Service
  • getList users

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

List Users Service

The User Management REST Web Service provides an endpoint for retrieving a list of users on the site, with support for applying filters through querystring parameters.

List users

List users in the site with filters in querystring.

Request Query Params:

?name=<string>&email=<string>&company=<string>&roles=<int[]>&active=<bool>

Remarks

API does not return deleted users.

Authorizations:

SessionAuth

query Parameters

name	string
email	string
company	string
roles	string
active	boolean

Responses

Response Schema: application/json

Count required	integer <int32> Number of Items in collection
required	Array of objects (ThruPublicUserInfo) Collection

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

Response samples

• 200

Content type

application/json

{

• "Count": 4,
• "Items": [

  • {

    • "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

    }

  ]

}