PUT Users/User/{userID}?validateOnly={validateOnly}
Update user
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userID |
UserID of User to be updated |
integer |
Required |
validateOnly |
Validate data, but don't post it |
boolean |
Default value is False |
Body Parameters
User data
UserDTOName | Description | Type | Additional information |
---|---|---|---|
UserID |
The unique identifier for the User record. |
integer |
None. |
AuthType |
The login authorization type for the User, . |
AuthType |
None. |
AuthName |
UserName for SSO Login |
string |
None. |
UserName |
UserName for the User. |
string |
None. |
UserPasswordLastUpdatedOnUtc |
Date and time the User's password was last updated in UTC. This field is readonly. |
date |
None. |
IsPasswordChangeRequired |
Flags whether the User is required to change their password. |
boolean |
None. |
IsPasswordValidationRequired |
Flags whether password validation is required for the User, when password is changed. |
boolean |
None. |
JobTitle |
User's job title. |
string |
None. |
EmailAddress |
User's email address. |
string |
None. |
Props |
A collection of additional properties for the User, . |
Collection of Object |
None. |
Comments |
Comments for the User. |
string |
None. |
LastLoginDateUtc |
Date and time the User last logged in, in UTC. This field is readonly. |
date |
None. |
IsLockedOut |
Flags whether the User is locked out. Prevents the User from logging in if set to true. |
boolean |
None. |
TZID |
The User's preferred time zone ID in IANA/TZDB time zone format. "Australia/Sydney" |
string |
None. |
Language |
The User's preferred language. |
string |
None. |
IsUserPasswordNoExpire |
Flags whether the User's password should expire. |
boolean |
None. |
StartDateUtc |
Start date and time for the User, in UTC. User will be unable to login before this date and time. |
date |
None. |
StopDateUtc |
Stop date and time for the User, in UTC. User will be unable to login after this date and time. |
date |
None. |
StartTimeUtc |
Start time for the User, in UTC. User will be unable to login before this time. |
date |
None. |
StopTimeUtc |
Stop time for the User, in UTC. User will be unable to login after this time. |
date |
None. |
UserPasswordFailedAttemptCount |
Number of times the User has failed to login with incorrect password. |
integer |
None. |
UserPasswordFailedAttemptWindowStartUtc |
Date and time the User's failed login attempt window started, in UTC. |
date |
None. |
RecordState |
Record State, |
RecordState |
None. |
WindowsTZ |
Windows time zone identifier. This field is readonly. |
string |
None. |
Name |
The User's name, . |
NameDTO |
None. |
Created |
The audit information for the creation of the record, including the creation date in UTC and the user who created it, . This field is readonly. |
AuditDataDTO |
None. |
LastUpdated |
The audit information for the last update to the record, including the update date in UTC and the user who made the update, . This field is readonly. |
AuditDataDTO |
None. |
Entities |
A collection of entities associated with the User, . Currently this would be limited to |
Collection of IPersonDTO |
None. |
DatabaseCount |
Number of tenant databases the User has access to. |
integer |
None. |
Databases |
Collection of tenant databases the User has access to, . |
Collection of OrganizationDatabaseDTO |
None. |
DBID |
The unique identifier of the database the User is currently logged into. This field is readonly. |
integer |
None. |
BusinessUnits |
Collection of Business Units the User has access to. |
Collection of integer |
None. |
AuthorizationGroups |
Collection of authorization groups the User belongs to. |
Collection of integer |
None. |
Groups |
Collection of groups the User has access to, . |
Collection of BusinessUnitChildDTO |
None. |
Forms |
Collection of forms the User has access to, . |
Collection of UserSubAuthorization |
None. |
NoteTypes |
Collection of Note Types the User has access to, . |
Collection of UserSubAuthorization |
None. |
Privileges |
Collection of Privileges assigned to the User. |
Collection of integer |
None. |
UIPrivileges |
Collection of UI Privileges assigned to the User. |
Collection of integer |
None. |
Reports |
Collection of Reports the User has access to. |
Collection of integer |
None. |
Summary |
Alias for UserName. This field is readonly. |
string |
None. |
IntegrationSource |
Integration source user has been created from. |
IntegrationSource |
None. |
DateFormat |
User's preferred date format. |
string |
None. |
IsMilitaryTime |
Flag indicating if the user prefers military time. |
boolean |
None. |
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |