REST API Guide

10.2.1
- 10.5.3
- 10.5.0
- 10.4.0
- 10.2.3
- 10.2.2 HotFix 1
- 10.2.2
- 10.2

Back Next

Find Web User REST API

Use the Find Web User REST API to find an Informatica Managed File Transfer web user using a search expression. This API uses the POST method.

Use the following URL for the REST API call:

POST http://<hostName>:<portNumber>/informaticamft/api/v1/webusers/search

is the host name or IP address of the Managed File Transfer server.

is the port number of the Managed File Transfer server. The default port for HTTP is 8000 and the default port for HTTPS is 8002, for example,

http://myserver:8000

https://myserver:8002

You can provide a request body in JSON to the REST API call. The following table describes the request body objects:

Object	Arguments
firstResult	Specify the first result to present.
maxResults	Specify the maximum number of results to present.
selectedSortColumn	Select which column is used to sort the resource information.
sortAscending	Sort the resources in ascending order.
matchAll	Provide all the matches to the search expression when performing the search.
useExactMatch	Exactly match the search expression when performing the search.
simpleSearchString	Use a simple search string to perform the search.
simpleSearch	Use a simple search to perform the search.
searchString	Specify the search string used to perform the search.
webUserNames	List of web user names to search for.

The following table describes the response body objects:

Object	Arguments
id	Specify the web user identification number.
name	User name of the web user.
firstName	First name of the web user.
firstName	Last name of the web user.
emailId	The email address of the web user.
status	Status of the web user.
organization	Organization associated with the web user.

Request Body Example

The following code shows a sample request body:

{   
   "firstResult":0,
   "maxResults":50,
   "selectedSortColumn":0,
   "sortAscending":true,
   "matchAll":true,
   "useExactMatch":false,
   "simpleSearchString":null,
   "simpleSearch":false,
   "searchString":null,
   "webUserNames":null,
   "markExisting":false
}

Response Body Examples

The following code shows a response body:

[   
   {   
      "id":1010,
      "username":"automationweb",
      "firstName":"1234567890123456",
      "lastName":"akash",
      "emailId":"srivastava",
      "status":"Enabled",
      "organization":"automationweb"
   },
   {   
      "id":1161,
      "username":"hostedWebUser_receive",
      "firstName":"hosted",
      "lastName":"webUser",
      "emailId":"hostedEndpoint@gmail.com",
      "status":"Enabled",
      "organization":""
   },
   {   
      "id":1162,
      "username":"hostedWebUser_send",
      "firstName":"hosted",
      "lastName":"webUser",
      "emailId":"hostedEndpointSend@gmail.com",
      "status":"Enabled",
      "organization":""
   },
   {   
      "id":1163,
      "username":"hostedWebUser_send_zip",
      "firstName":"hosted",
      "lastName":"webUser",
      "emailId":"hostedepsendzip@gmail.com",
      "status":"Enabled",
      "organization":""
   },
   {   
      "id":1155,
      "username":"https",
      "firstName":"",
      "lastName":"",
      "emailId":"",
      "status":"Enabled",
      "organization":""
   },
   {   
      "id":1156,
      "username":"new",
      "firstName":"",
      "lastName":"",
      "emailId":"",
      "status":"Enabled",
      "organization":""
   },
   {   
      "id":1157,
      "username":"Test",
      "firstName":"",
      "lastName":"",
      "emailId":"",
      "status":"Enabled",
      "organization":""
   },
   {   
      "id":1169,
      "username":"testWebUser",
      "firstName":"test",
      "lastName":"WebUser",
      "emailId":"test@informatica.com",
      "status":"Enabled",
      "organization":"Informatica"
   }
]

Rename Saved Search

Table of Contents

REST API Guide

REST API Guide

Find Web User REST API

Find Web User REST API

Request Body Example

Response Body Examples