REST API Guide

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

Back Next

Find Web User by ID REST API

Use the

userId

REST API to find an Informatica Managed File Transfer web user by an identification number. This API uses the GET method.

Use the following URL for the REST API call:

GET http://<hostName>:<portNumber>/informaticamft/api/v1/webusers/{userId}

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

The following table describes the request variable:

Object	Arguments
userId	The database ID of the web user.

The following table describes the response body objects:

Object	Arguments
id	Specify the resource identification number.
name	User name of the web user.
firstName	First name of the web user.
lastName	Last name of the web user.
description	Description of the web user.
password	The password associated with the web user.
passwordIsEncrypted	Indicates whether or not the password is encrypted.
passwordHashAlgorithm	Indicates whether or not the password is encrypted with a hash algorithm. Supported hash algorithms are MD2, MD5, SHA-1, SHA-256, SHA-384 and SHA-512. The algorithms must be specified in upper case.
fingerprint	Fingerprint associated with the web user.
loginAttempts	The number of allowed login attempts.
email	The email address of the web user.
organization	The organization associated with the web user.
phone	The telephone number of the web user.
enabled	The web user is enabled.
approved	The web user is approved.
accountExpiresOn	The date that the web user account expires.
passwordExpirationInterval	The interval after which the web user password expires.
passwordChangedOn	The date that the web user password changed.
forcePasswordChange	Indicates whether the password must change.
servicePermissions	Indicates which services the web user has permission to access.
secureMailPermissions	Indicates that the web user can access Secure Mail.
changePasswordPermission	This option makes a Change Password link available at the top of the page in the File Transfer Portal for members of the Web User Group.
lastLoginDate	The last date on which the web user logged in.
createdBy	The entity that created the web user.
createdOn	Time when the web user was created.
modifiedBy	The entity that modified the web user.
modifiedOn	Time when the web user was modified.
ipFilterEnabled	Filter access according to IP. The IP Filter can be enabled or disabled at the individual Web User level.
ipFilterType	Type of IP filter. A Blacklist will deny any specified addresses and permit all others, whereas a Whitelist will only permit the specified addresses and deny all others.
ipFilterEntries	List of IP addresses. The Filter Entries is a list of IP addresses that will either be denied or permitted based on the Filter Type selected above.
generatePassword	Generate a password.
displayPassword	Display the password.
emailPassword	Provide email password.
loginMethod	Specify the login method.
loginMethodName	Name of the login method.
inactiveDays	Number of days that the web user was not active. The Web User account can be disabled after a number of inactive days. Inactive days are calculated from the last login date or the last date the account was modified.
AS2Id	The ID of the sender (Web User). The ID is case sensitive and can be 1 to 128 ASCII printable characters in length.
AS2SignatureAlias	This is the alias of the public certificate used by this Web User to sign their messages. If
AS2UploadDir	The location where messages are saved when received.
AS2WhenFileExist	The action that Managed File Transfer performs when a file with the same name already exists in the default upload folder.
AS2RequireEncryption	This option indicates whether or not messages sent by this Web User must be encrypted.
AS2RequireSignature	A signed message contains a digital signature from the sender to further authenticate the message. If signatures are required, any unsigned message sent by this Web User will be rejected.
AS2RequireAuthentication	Require username/password or certificate authentication for messages uploads. If authentication is not required, Managed File Transfer will use the ID to identify the Web User. Informatica recommends you set the 'Require Signature' option to 'true' when authentication is not required.
AS2MdnApprovalAutomatic	If a return receipt is requested by the Web User, select if the MDN will be sent automatically during the Web User's session or manually after the message is processed.
HTTPSFingerprint	If the specified Web User Template has the Authentication Type for HTTPS set to Certificate or Either, the HTTPSFingerprint column is required.
AS2Fingerprint	If the specified Web User Template has the Authentication Type for AS2 set to Certificate, Either, or Certificate and Password, the AS2Fingerprint column is required.
FTPESFingerprint	If the specified Web User Template has the Authentication Type for FTPES set to Certificate, Either or Certificate and Password, the FTPESFingerprint column is required.
FTPSFingerprint	If the specified Web User Template has the Authentication Type for FTPS set to Certificate, Either or Certificate and Password, the FTPSFingerprint column is required.
approvedBy	The entity that approved file send or receive.
approvedOn	Time when the file send or receive was approved.
pwdExpSentOn	The last time that a password expiration notification was sent.
maxSessions	Maximum number of sessions allowed.
inviteUserPermission	Assign permissions to invite another user to web user self-service.
invitedBy	The entity that invited the web user.
invitedOn	The time that the web user was invited.
pastExpiration	The entity has passed the expiration date.
limitTime	Limit the time period in which the Web User can login.
limitTimeStart	Start of the time period in which the Web User can login.
limitTimeEnd	End of the time period in which the Web User can login.
limitDays	Limit time of day the Web User can login.
limitDaysOfWeek	Limit which days of the week the Web User can login.
viewActivityPermission	This option allows Web Users to view their own activity report from the Managed File Transfer File Transfer Portal. Web Users will be able to view their login activity, as well as audit logs on their file uploads and downloads.
goDrivePermission	This option provides Web Users the ability to use the Shared Drive file system for collaboration, sharing and synchronization of documents.
goDriveAccessType	When Shared Drive is enabled for the Web User, you can select the Web User access level.
secureFolderPermission	The Secure Folders option provides Web Users the ability to work with authorized network folders and files from within the browser-based File Transfer Portal.
userGoDriveDiskQuotaOption	Select whether to enable a maximum amount of disk space available for this Web User in Shared Drive.
userGoDriveDiskSpace	The maximum amount of disk space available for this Web User in Shared Drive.
userGoDriveDiskSpaceUnit	The unit of space used to specify the maximum amount of disk space in Shared Drive.
privateKey	Specify a private key that the web user uses.
algorithm	Specify the algorithm used with the private key.
privateKeyPassword	Specify the password for the private key.
sshKeys	List of SSH keys associated with the web user.
goDriveAccessTypeCode	The access type code for the Shared Drive.
userGoDriveDiskSpaceUnitCode	The disk space unit code for the Shared Drive.

Response Body Examples

The following code shows a response body:

{
    "id": 1046,
    "name": "ipw1234172",
    "firstName": "",
    "lastName": "",
    "description": "",
    "ghttpsAuthType": "P",
    "gas2AuthType": "P",
    "gftpesAuthType": "P",
    "gftpsAuthType": "P",
    "gsftpAuthType": "P",
    "password": " /reoVbQpbE9YJBGtRm3NivBA==",
    "passwordIsEncrypted": true,
    "passwordHashAlgorithm": "SHA512",
    "loginAttempts": 0,
    "email": "",
    "organization": "",
    "phone": "",
    "enabled": true,
    "approved": true,
    "passwordExpirationInterval": -1,
    "passwordChangedOn": 1613730897203,
    "forcePasswordChange": false,
    "servicePermissions": 31,
    "secureMailPermissions": 1,
    "changePasswordPermission": false,
    "createdBy": "administrator",
    "createdOn": 1613730897203,
    "modifiedBy": "administrator",
    "modifiedOn": 1613730897203,
    "ipFilterEnabled": false,
    "ipFilterType": "D",
    "ipFilterEntries": [
        {
            "value": "2405:201:d01c:2002::c0a8:1d01"
        }
    ],
    "generatePassword": 0,
    "displayPassword": false,
    "emailPassword": false,
    "loginMethod": 101,
    "inactiveDays": -1,
    "as2Id": "",
    "as2SignatureAlias": "",
    "as2WhenFileExist": -1,
    "as2RequireEncryption": "",
    "as2RequireSignature": "",
    "as2RequireAuthentication": "",
    "as2MdnApprovalAutomatic": "",
    "maxSessions": -1,
    "inviteUserPermission": true,
    "homeDirectory": {
        "id": 1068,
        "definedOnUser": true
    },
    "pastExpiration": false,
    "limitTime": 0,
    "limitDays": 0,
    "limitDaysOfWeek": 0,
    "viewActivityPermission": true,
    "goDrivePermission": true,
    "goDriveAccessType": "FULLACCESS",
    "secureFolderPermission": true,
    "userGoDriveDiskQuotaOption": "NOT_SPECIFIED",
    "userGoDriveDiskSpace": 5,
    "userGoDriveDiskSpaceUnit": "GB",
    "sshKeys": []
}

Rename Saved Search

Table of Contents

REST API Guide

REST API Guide

Find Web User by ID REST API

Find Web User by ID REST API

Response Body Examples