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

Toggle Pane

• Manage Users in Groups
  • putUpdate UserGroup
  • getList User Groups
  • getList users in a User Group
  • postAdd User to User Group
  • delDelete user from a User Group

API docs by Redocly

Download OpenAPI Specification: Download

Manage Users in Groups

The User Group Management REST Web Services provide endpoints for administering user groups within the system. These APIs enable updating group information by group ID, listing all groups in the site, retrieving users within a specific group, and managing group membership by adding or removing users through their respective identifiers.

Update UserGroup

Update group data by a group ID.

Remarks

GroupID is required in 2 places: on the URL and in the object ThruPublicGroupInfo.

GroupID value on URL is used, the value in ThruPublicGroupInfo is ignored.

Authorizations:

SessionAuth

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

required

Request body — Request type: ThruPublicGroupInfo — Schema: ThruPublicGroupInfo structure contains information about MFT file sharing user account.

Description required	string Group Description
Id required	string Identifier of a group in Thru
ModifyRole required	string Manager = 4, or Administrator = 5
Name required	string Group Name
UserGroupType required	string 1 – 17: built-in security groups 0: user defined groups

Responses

https://{MFTWebServer}/REST/{version}/UserGroups/{groupId}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

Description=Cust1+Group&Id=1Q1OBQWVHTROE&ModifyRole=4&Name=Group1&UserGroupType=16

List User Groups

List all groups in the site

Authorizations:

SessionAuth

Responses

Response Schema: application/json

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

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

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

    }

  ]

}

List users in a User Group

List users in a User Group by userGroupID

Authorizations:

SessionAuth

Responses

Response Schema: application/json

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

https://{MFTWebServer}/REST/{version}/UserGroups/{groupId}/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

    }

  ]

}

Add User to User Group

Add User to UserGroup using UserID and UserGroupID

Authorizations:

SessionAuth

Responses

https://{MFTWebServer}/REST/{version}/UserGroups/{groupId}/Users/{userId}

Delete user from a User Group

Delete user from a User Group using UserID and UserGroupID

Authorizations:

SessionAuth

Responses

https://{MFTWebServer}/REST/{version}/UserGroups/{groupId}/Users/{userId}