User

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  User
Represents user of the system.
id
References: User.Code
XML Representation: attribute
Attributes: Unique, CreateOnly
Default Value
Identifier of the object used for references; auto-incremented integer value.
code
References: User.Reference Code
XML Representation: attribute
Attributes: CreateOnly
Default Value
See Reference Code definition for additional information.
createDate
Type: Datetime
XML Representation: attribute
Attributes:
Default Value
name
Type: String
XML Representation: attribute
Attributes: Required
Default Value
title
References: User.Title
XML Representation: attribute
Attributes:
Default Value
Employee title of the user, where applicable.
emailemail-list
References: User.Email
XML Representation: attribute
Attributes: Required
Default Value
Email associated with this user account.
userName
Type: String
XML Representation: attribute
Attributes: Required
Default Value
password
References: User.Password
XML Representation: attribute
Attributes: Required
Default Value
Password associated with this user account.

'Note: 'The passwords are stored as SHA1 hash.''
passwordExpirationDate
References: User.Password Expiration Date
XML Representation: attribute
Attributes:
Default Value
Date after which the current password is no longer valid and must be changed. The field is used to enforce strong password policy that requires regular password reset.

Expiration period is controlled by a system property (unipay.system.user-password-expiration-period) and is equal to 90 days by default.
securityImage
References: User.Security Image
XML Representation: attribute
Attributes:
Default Value
The image that is used by the user to provide better security while logging in the system.
failedLoginCount
References: User.Failed Login Count
XML Representation: attribute
Attributes:
Default Value
Number of failed login attempts.
securityType
Type: String(2)
XML Representation: attribute
Attributes: Required
Default Value
securityLevel
References: User.Security Level
XML Representation: attribute
Attributes:
Default Value
Indicates security level for this user.
roleCode
Type: String(2)
XML Representation: attribute
Attributes:
Default Value
functionPolicy
References: User.Function Policy
XML Representation: attribute
Attributes:
Default Value
Regulates function abilities of the user within the system.
department
References: User.Department
XML Representation: attribute
Attributes:
Default Value
Employee department of the user, where applicable.
securityQuestion
References: User.Security Question
XML Representation: attribute
Attributes:
Default Value
Security question selected by this user for the case when the password is lost.
securityAnswer
References: User.Security Answer
XML Representation: attribute
Attributes:
Default Value
Security answer to the security question, selected by this user.
licenseAgreementAcceptanceDate
XML Representation: attribute
Attributes:
Default Value
Date when user accepted the licence agreement.
timeZone
References: User.Time Zone Code
XML Representation: attribute
Attributes:
Default Value
Represents the time zone associated with this user.
notes
References: User.Notes
XML Representation: attribute
Attributes:
Default Value
Possible notes concerning this user account.
defaultMerchantCode
References: User.Default Merchant Code
XML Representation: attribute
Attributes:
Default Value
Code of the merchant, which used as a default value when merchant selection for this user is required.

The value is often used on UI to initialize some of the forms with default merchant selection.
defaultMerchantAccountCode
XML Representation: attribute
Attributes: Required
Default Value
Code of the merchant account, which used as a default value when merchant account selection for this user is required.

The value is often used on UI to initialize some of the forms with default merchant account selection. The merchant account must belong to the default merchant associated with this user.
owner
References: User.Owner Cl
XML Representation: attribute
Attributes:
Default Value
Reference to the entity that represents possible types of the owner.
Values can be the following:
S - System
P - Portfolio
R - Reseller
M - Merchant
C - Customer
U - User
F - Fulfillment Center
ownerCode
References: User.Owner Code
XML Representation: attribute
Attributes:
Default Value
Internal code of the user.
secretKey
References: User.Secret Key
XML Representation: attribute
Attributes:
Default Value
Authorization key being masked for secure storage within the system used for generation of one-time password.
privileges
References: User.Privileges
XML Representation: attribute
Attributes:
Default Value
Privileges assigned to the user.
additionalPassword
Type: String(11)
XML Representation: attribute
Attributes:
Default Value
rawAccountDataModeType
XML Representation: attribute
Attributes: Required
Default Value
responseMessageDisplayPolicy
XML Representation: attribute
Attributes: Required
Default Value
authenticationMode
References: User.Authentication Cl
XML Representation: attribute
Attributes: Required
Default Value P
This parameter determine what password allow used "temporary" or "temporary and permanent" for gates and redirects requests
statusType
References: User.User Status Cl
XML Representation: attribute
Attributes:
Default Value Active

XML Sample:

<user
    id="1" 
    code="1" 
    createDate="2013-12-31" 
    isActive="true" 
    name="John Smith" 
    title="John Smith" 
    emailemail-list="john.smith@sampleuser.com" 
    userName="jsmith" 
    password="testPassword" 
    passwordExpirationDate="2014-12-31" 
    securityImage="category/image.png" 
    failedLoginCount="5" 
    securityType="S2" 
    securityLevel="1" 
    roleCode="1X" 
    functionPolicy="type1, type2" 
    department="Administration" 
    securityQuestion="Brand of the first car" 
    securityAnswer="answer" 
    licenseAgreementAcceptanceDate="2013-12-31" 
    timeZone="EST" 
    notes=" Some sample notes about the user" 
    defaultMerchantCode="123456789009" 
    defaultMerchantAccountCode="123456789009" 
    owner="R" 
    ownerCode="1" 
    secretKey="ULTYX7TSQRS7TJTC" 
    privileges="" 
    additionalPassword="" 
    rawAccountDataModeType="R" 
    responseMessageDisplayPolicy="U-H" 
    authenticationMode="P" 
    statusType="" 
    passwordNext="" 
    additionalPasswordNext="" 
    passwordNextCreateDate="2014-12-31" />

"<user id=\"1\" code=\"1\" createDate=\"2013-12-31\" isActive=\"true\" name=\"John Smith\" title=\"John Smith\" emailemail-list=\"john.smith@sampleuser.com\" userName=\"jsmith\" password=\"testPassword\" passwordExpirationDate=\"2014-12-31\" securityImage=\"category/image.png\" failedLoginCount=\"5\" securityType=\"S2\" securityLevel=\"1\" roleCode=\"1X\" functionPolicy=\"type1, type2\" department=\"Administration\" securityQuestion=\"Brand of the first car\" securityAnswer=\"answer\" licenseAgreementAcceptanceDate=\"2013-12-31\" timeZone=\"EST\" notes=\" Some sample notes about the user\" defaultMerchantCode=\"123456789009\" defaultMerchantAccountCode=\"123456789009\" owner=\"R\" ownerCode=\"1\" secretKey=\"ULTYX7TSQRS7TJTC\" privileges=\"\" additionalPassword=\"\" rawAccountDataModeType=\"R\" responseMessageDisplayPolicy=\"U-H\" authenticationMode=\"P\" statusType=\"\" passwordNext=\"\" additionalPasswordNext=\"\" passwordNextCreateDate=\"2014-12-31\" />"

JSON Sample:

{
  "id": 1,
  "code": 1,
  "createDate": "2013-12-31",
  "isActive": true,
  "name": "John Smith",
  "title": "John Smith",
  "emailemail-list": "john.smith@sampleuser.com",
  "userName": "jsmith",
  "password": "testPassword",
  "passwordExpirationDate": "2014-12-31",
  "securityImage": "category\/image.png",
  "failedLoginCount": 5,
  "securityType": "S2",
  "securityLevel": 1,
  "roleCode": "1X",
  "functionPolicy": "type1, type2",
  "department": "Administration",
  "securityQuestion": "Brand of the first car",
  "securityAnswer": "answer",
  "licenseAgreementAcceptanceDate": "2013-12-31",
  "timeZone": "EST",
  "notes": " Some sample notes about the user",
  "defaultMerchantCode": "123456789009",
  "defaultMerchantAccountCode": "123456789009",
  "owner": "R",
  "ownerCode": 1,
  "secretKey": "ULTYX7TSQRS7TJTC",
  "privileges": "",
  "additionalPassword": "",
  "rawAccountDataModeType": "R",
  "responseMessageDisplayPolicy": "U-H",
  "authenticationMode": "P",
  "statusType": "",
  "passwordNext": "",
  "additionalPasswordNext": "",
  "passwordNextCreateDate": "2014-12-31"
}

Query String Sample:

?id=1&code=1&createDate=2013-12-31&isActive=true&name=John+Smith&title=John+Smith&emailemail-list=john.smith%40sampleuser.com&userName=jsmith&password=testPassword&passwordExpirationDate=2014-12-31&securityImage=category%2Fimage.png&failedLoginCount=5&securityType=S2&securityLevel=1&roleCode=1X&functionPolicy=type1%2C+type2&department=Administration&securityQuestion=Brand+of+the+first+car&securityAnswer=answer&licenseAgreementAcceptanceDate=2013-12-31&timeZone=EST&notes=+Some+sample+notes+about+the+user&defaultMerchantCode=123456789009&defaultMerchantAccountCode=123456789009&owner=R&ownerCode=1&secretKey=ULTYX7TSQRS7TJTC&privileges=&additionalPassword=&rawAccountDataModeType=R&responseMessageDisplayPolicy=U-H&authenticationMode=P&statusType=&passwordNext=&additionalPasswordNext=&passwordNextCreateDate=2014-12-31&
id=1
code=1
createDate=2013-12-31
isActive=true
name=John Smith
title=John Smith
emailemail-list=john.smith@sampleuser.com
userName=jsmith
password=testPassword
passwordExpirationDate=2014-12-31
securityImage=category/image.png
failedLoginCount=5
securityType=S2
securityLevel=1
roleCode=1X
functionPolicy=type1, type2
department=Administration
securityQuestion=Brand of the first car
securityAnswer=answer
licenseAgreementAcceptanceDate=2013-12-31
timeZone=EST
notes= Some sample notes about the user
defaultMerchantCode=123456789009
defaultMerchantAccountCode=123456789009
owner=R
ownerCode=1
secretKey=ULTYX7TSQRS7TJTC
privileges=
additionalPassword=
rawAccountDataModeType=R
responseMessageDisplayPolicy=U-H
authenticationMode=P
statusType=
passwordNext=
additionalPasswordNext=
passwordNextCreateDate=2014-12-31