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

Toggle Pane

• Folder Permissions
  • getList folder permissions
  • postAdd folder permission for a user
  • postAdd folder permission for a user group
  • putUpdate a folder permission
  • delDelete one or more folder permissions

API docs by Redocly

Download OpenAPI Specification: Download

Folder Permissions

The Folder Permissions REST Web Services provide endpoints for managing access control on folders within the file system. These APIs enable listing existing user and group permissions, adding new permissions for individual users or groups, updating existing permission entries, and deleting one or more permissions as needed.

List folder permissions

List folder permissions

Authorizations:

SessionAuth

path Parameters

folderId required

string Folder ID

Responses

https://{MFTWebServer}/REST/{version}/REST/1.0/FileSystem/Folder/{folderId}/Permissions

Add folder permission for a user

Authorizations:

SessionAuth

path Parameters

folderId required	string
userId required	string

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

required

Permission required

string Permission level code

Responses

https://{MFTWebServer}/REST/{version}/REST/1.0/FileSystem/Folder/{folderId}/Permission/User/{userId}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

Permission=8

Add folder permission for a user group

Authorizations:

SessionAuth

path Parameters

folderId required	string
userGroupId required	string

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

required

Permission required

string Permission level code

Responses

https://{MFTWebServer}/REST/{version}/REST/1.0/FileSystem/Folder/{folderId}/Permission/UserGroup/{userGroupId}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

Permission=8

Update a folder permission

Authorizations:

SessionAuth

path Parameters

folderId required	string
permissionId required	string

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

required

permission required

string Permission level code

Responses

https://{MFTWebServer}/REST/{version}/REST/1.0/FileSystem/Folder/{folderId}/Permission/{permissionId}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

permission=8

Delete one or more folder permissions

Authorizations:

SessionAuth

path Parameters

folderId required	string
permissionId required	string

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

optional

property name* additional property

any

Responses

https://{MFTWebServer}/REST/{version}/REST/1.0/FileSystem/Folder/{folderId}/Permission/{permissionId}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

Items[2][Permission]=8&Items[2][UserID]=0GTPV115Q5DEQ&Items[2][FolderID]=2DRPJYLZC2Z3O&Items[1][Permission]=254&Items[1][UserID]=1UBRSWNZCJDCS&Items[1][FolderID]=2DRPJYLZC2Z3O&Items[0][Permission]=254&Items[0][UserGroupID]=2VGV8HHIRVUT7&Items[0][FolderID]=1BNZAOJZUQ5TI