User

Type: Struct

Abstract: no

Status: Active

Java Class: User

Represents user of the system.

Available Fields:

additionalPassword
authenticationMode
code
createDate
defaultMerchantAccountCode
defaultMerchantCode
department
email
failedLoginCount
functionPolicy

id
licenseAgreementAcceptanceDate
name
notes
owner
ownerCode
password
passwordExpirationDate
privileges
rawAccountDataModeType

responseMessageDisplayPolicy
roleCode
secretKey
securityAnswer
securityImage
securityLevel
securityQuestion
securityType
statusType
timeZone

title
userName

References: User.Code

XML Representation: attribute

Attributes: Unique, CreateOnly

Default Value

Unique User ID generated by the system.

code

References: User.Reference Code

XML Representation: attribute

Attributes: CreateOnly

Default Value

Unique User ID supplied by external/user's system.

Notr: For more information see Reference Code.

createDate

References: User.Create Date

XML Representation: attribute

Attributes:

Default Value

Date when the User was created.

name

References: User.Name

XML Representation: attribute

Attributes: Required

Default Value

Pattern:

Full name of the User.

Note: This field is used to create both Service and Human Users.

title

References: User.Title

XML Representation: attribute

Attributes:

Default Value

Employee title of the user, where applicable.

References: User.Email

XML Representation: attribute

Attributes: Required

Default Value

Pattern:

Email address of the User.

Note: This field is used to create both Service and Human Users.

userName

References: User.User Name

XML Representation: attribute

Attributes: Required

Default Value

Pattern:

Username associated with this user account.

Note: This field is used to create both Service and Human Users.

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. This field is used to create both Service and Human Users.

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

Note: This field is used to create both Service and Human Users.

securityLevel

References: User.Security Level

XML Representation: attribute

Attributes:

Default Value

Indicates security level for this user.

Note: This field is used to create both Service and Human Users.

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.

Note: This field is used to create Service User.

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

References: User.License Agreement Acceptance Date

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.

Note: This field is used to create both Service and Human Users.

defaultMerchantAccountCode

References: User.Default Merchant Account Code

XML Representation: attribute

Attributes:

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.

Note: This field is used to create both Service and Human Users.

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

Note: This field is used to create both Service and Human Users.

ownerCode

References: User.Owner Code

XML Representation: attribute

Attributes:

Default Value

Internal code of the user.

Note: This field is used to create both Service and Human Users.

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.

Note: This field is used to create both Service and Human Users.

additionalPassword

References: User.Additional Password

XML Representation: attribute

Attributes:

Default Value

Additional password for this user account.

rawAccountDataModeType

References: User.Raw Account Data Mode Classifier

XML Representation: attribute

Attributes: Required

Default Value

Note: This field is used to create both Service and Human Users.

responseMessageDisplayPolicy

References: User.Response Message Display Policy

XML Representation: attribute

Attributes: Required

Default Value

Note: This field is used to create both Service and Human Users.

authenticationMode

References: User.Authentication Cl

XML Representation: attribute

Attributes: Required

This parameter determine what password allow used "temporary" or "temporary and permanent" for gates and redirects requests

Note: This field is used to create Service User.

statusType

References: User.User Status Cl

XML Representation: attribute

Attributes:

Note: This field is used to create both Service and Human Users.

XML Sample:

<user>
     <user
         name="August Little" 
         email="little.zoo@lycos.com" 
         userName="api-cookedup" 
         password="r01DDpS9o2UOkRPS2upAD1RSGbNvViVM" 
         securityType="S2" 
         securityLevel="'1'" 
         functionPolicy="---" 
         defaultMerchantCode="'2000'" 
         defaultMerchantAccountCode="'2001'" 
         owner="S" 
         ownerCode="'1'" 
         privileges="'6'" 
         rawAccountDataModeType="UA" 
         responseMessageDisplayPolicy="U-H" 
         authenticationMode="P" 
         statusType="A" />
</user>

"<user> <user name=\"August Little\" email=\"little.zoo@lycos.com\" userName=\"api-cookedup\" password=\"r01DDpS9o2UOkRPS2upAD1RSGbNvViVM\" securityType=\"S2\" securityLevel=\"\'1\'\" functionPolicy=\"---\" defaultMerchantCode=\"\'2000\'\" defaultMerchantAccountCode=\"\'2001\'\" owner=\"S\" ownerCode=\"\'1\'\" privileges=\"\'6\'\" rawAccountDataModeType=\"UA\" responseMessageDisplayPolicy=\"U-H\" authenticationMode=\"P\" statusType=\"A\" /></user>"

JSON Sample:

{
  "name": "August Little",
  "email": "little.zoo@lycos.com",
  "userName": "api-cookedup",
  "password": "r01DDpS9o2UOkRPS2upAD1RSGbNvViVM",
  "securityType": "S2",
  "securityLevel": "'1'",
  "functionPolicy": "---",
  "defaultMerchantCode": "'2000'",
  "defaultMerchantAccountCode": "'2001'",
  "owner": "S",
  "ownerCode": "'1'",
  "privileges": "'6'",
  "rawAccountDataModeType": "UA",
  "responseMessageDisplayPolicy": "U-H",
  "authenticationMode": "P",
  "statusType": "A"
}

XURL Sample:

?name=August+Little&email=little.zoo%40lycos.com&userName=api-cookedup&password=r01DDpS9o2UOkRPS2upAD1RSGbNvViVM&securityType=S2&securityLevel=%271%27&functionPolicy=---&defaultMerchantCode=%272000%27&defaultMerchantAccountCode=%272001%27&owner=S&ownerCode=%271%27&privileges=%276%27&rawAccountDataModeType=UA&responseMessageDisplayPolicy=U-H&authenticationMode=P&statusType=A&

name=August Little
email=little.zoo@lycos.com
userName=api-cookedup
password=r01DDpS9o2UOkRPS2upAD1RSGbNvViVM
securityType=S2
securityLevel='1'
functionPolicy=---
defaultMerchantCode='2000'
defaultMerchantAccountCode='2001'
owner=S
ownerCode='1'
privileges='6'
rawAccountDataModeType=UA
responseMessageDisplayPolicy=U-H
authenticationMode=P
statusType=A