UserDetail

Field Null Description Note
password
string		 Y The password  
roles
array of objects		   An array of Role objects Only allow null when user is a system admin
userRoles
array of objects		 Y An array of UserRole objects  
userSecurityQuestions
array of objects		 Y An array of UserSecurityQuestion objects  
status
integer		  

The status

  • 1 = Active
  • 2 = Deactive
  • 3 = PasswordNotSet
  • 4 = LoginAttemptFailed
  • 5 = AnswerAttempFailed
  
issueDate
datetime		   The time when token was generated  
autoLogin
boolean		   Whether system will auto login this user  
newPassword
string		 Y The new password  

Inherited fields:

User

Field NULL Description Note
userName
string		   The name of the user  
emailAddress
string		   The email address of the user  
firstName
string		   The first name of the user  
lastName
string		   The last name of the user  
tenantId
string (GUID)		 Y The id of the tenant if available  
tenantDisplayId
string		   The user-entered id of the tenant for display  
tenantName
string		 Y The name of the tenant if available  
dataOffset
decimal		 Y The time shift to be applied to datetime data from client database connections to match user’s local time As of v2.9.5, offset will accept partial hours as .25, .5 or .75
timestampOffset
decimal		 Y The time shift to be applied to timestamp data (created date time, last updated date time) from Izenda system database to match user’s local time zone As of v2.9.5, offset will accept partial hours as .25, .5 or .75
initPassword
boolean		   Has the password been initialized for a new user  
active
boolean		   Is the user activated  
retryLoginTime
integer		 Y The number of consecutive times that user fails to log in  
lastTimeAccessed
datetime		 Y The time when user last accessed the system  
passwordLastChanged
datetime		 Y The time when user last changed the password  
locked
boolean		 Y Is the user locked  
lockedDate
datetime		 Y The time when user was locked  
cultureName
string		 Y The culture name  
securityQuestionLastChanged
datetime		 Y The time when user last changed security questions  
dateFormat
string		   The user-selected date format  
systemAdmin
boolean		   Whether user is a system admin  
notAllowSharing
boolean		   Is sharing not allowed  
numberOfFailedSecurityQuestion
integer		 Y The number of security questions that user failed to answer  
fullName
string		   The full name  
currentModules
array of strings		 Y The list of assigned modules  

Inherited fields:

Entity

Field NULL Description Note
id
string (GUID)		   The id of this object
Example: 572bd576-8c92-4901-ab2a-b16e38144813		 Allow null incase insert a new entity
state
integer		  

The entity state of this object

  • 0 = None
  • 1 = Insert
  • 2 = Delete
  • 3 = Update
  
deleted
boolean		   Is this object deleted  
inserted
boolean		   Is this object inserted  
version
string		 Y The version  
created
datetime in ISO 8601 format		 Y The created datetime  
createdBy
string		   The creator  
modified
datetime in ISO 8601 format		 Y The modification datetime  
modifiedBy
string		   The user who last modified this object  
User Sample:
{
   "password" : null,
   "roles" : [{
         "name" : null,
         "tenantId" : null,
         "active" : false,
         "id" : "b992c772-6cb1-4103-b6b1-0da581368862",
         "state" : 0,
         "deleted" : false,
         "inserted" : true,
         "version" : null,
         "created" : null,
         "createdBy" : "e5dabf75-c5b7-4877-86cc-b3afd83eed62",
         "modified" : null,
         "modifiedBy" : null
      }
   ],
   "userRoles" : [{
         "userId" : "6c447061-8f1d-4ff4-803c-b6b15695b8c3",
         "roleId" : "b992c772-6cb1-4103-b6b1-0da581368862",
         "id" : "b15da0f4-d97d-4c78-bd52-22af0e02aae0",
         "state" : 0,
         "deleted" : false,
         "inserted" : true,
         "version" : 1,
         "created" : "2016-10-10T07:50:26.2366983",
         "createdBy" : "e5dabf75-c5b7-4877-86cc-b3afd83eed62",
         "modified" : "2016-10-10T07:50:26.2366983",
         "modifiedBy" : "e5dabf75-c5b7-4877-86cc-b3afd83eed62"
      }
   ],
   "userSecurityQuestions" : null,
   "status" : 3,
   "issueDate" : "0001-01-01T00:00:00",
   "autoLogin" : false,
   "newPassword" : null,
   "userName" : "jdoe",
   "emailAddress" : "jdoe@acme.com",
   "firstName" : "John",
   "lastName" : "Doe",
   "tenantId" : null,
   "tenantDisplayId" : null,
   "dataOffset" : 0,
   "timestampOffset" : 0,
   "initPassword" : false,
   "active" : false,
   "retryLoginTime" : null,
   "lastTimeAccessed" : null,
   "passwordActiveDate" : null,
   "locked" : null,
   "lockedDate" : null,
   "fullName" : "John Doe",
   "id" : "6c447061-8f1d-4ff4-803c-b6b15695b8c3",
   "state" : 0,
   "deleted" : false,
   "inserted" : false,
   "version" : 1,
   "created" : "2016-10-10T07:50:26.2366983",
   "createdBy" : "e5dabf75-c5b7-4877-86cc-b3afd83eed62",
   "modified" : "2016-10-10T07:50:26.2366983",
   "modifiedBy" : "e5dabf75-c5b7-4877-86cc-b3afd83eed62"
}
UserDetail Sample:
{
     "password" : null,
     "roles" : [],
     "userName" : "Anna",
     "emailAddress" : null,
     "firstName" : "An",
     "lastName" : "Na",
     "passwordHash" : null,
     "passwordSalt" : null,
     "currentTokenHash" : null,
     "tenantId" : null,
     "active" : false,
     "deleted" : false,
     "dataOffset" : 0,
     "timestampOffset" : 0,
     "fullName" : "An Na",
     "id" : "9f58703e-0dff-4690-9dc6-c595a6fd84e5",
     "state" : 0,
     "inserted" : true,
     "version" : 1,
     "created" : null,
     "createdBy" : null,
     "modified" : null,
     "modifiedBy" : null
  }