GET V2/Users/User
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Databases | Collection of integer |
None. |
|
| SortColumn | string |
None. |
|
| SortDirection | string |
None. |
|
| IncludeActive | boolean |
None. |
|
| IncludeInactive | boolean |
None. |
|
| IncludeDeleted | boolean |
None. |
|
| Match | MatchCriteriaStringType |
None. |
|
| UserName | string |
None. |
|
| Name | NameDTO |
None. |
|
| BusinessUnits | Collection of integer |
None. |
|
| AuthGroups | Collection of integer |
None. |
|
| EntityIDs | Collection of integer |
None. |
|
| CreatedDateUtcMin | date |
None. |
|
| CreatedDateUtcMax | date |
None. |
|
| LastUpdatedDateUtcMin | date |
None. |
|
| LastUpdatedDateUtcMax | date |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of UserDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID | integer |
None. |
|
| AuthType | AuthType |
None. |
|
| AuthName | string |
None. |
|
| UserName | string |
None. |
|
| UserPasswordLastUpdatedOnUtc | date |
None. |
|
| IsPasswordChangeRequired | boolean |
None. |
|
| IsPasswordValidationRequired | boolean |
None. |
|
| JobTitle | string |
None. |
|
| EmailAddress | string |
None. |
|
| Props | Collection of Object |
None. |
|
| Comments | string |
None. |
|
| LastLoginDateUtc | date |
None. |
|
| IsLockedOut | boolean |
None. |
|
| TZID | string |
None. |
|
| Language | string |
None. |
|
| IsUserPasswordNoExpire | boolean |
None. |
|
| StartDateUtc | date |
None. |
|
| StopDateUtc | date |
None. |
|
| StartTimeUtc | date |
None. |
|
| StopTimeUtc | date |
None. |
|
| UserPasswordFailedAttemptCount | integer |
None. |
|
| UserPasswordFailedAttemptWindowStartUtc | date |
None. |
|
| RecordState | RecordState |
None. |
|
| WindowsTZ | string |
None. |
|
| Name | NameDTO |
None. |
|
| Created | AuditDataDTO |
None. |
|
| LastUpdated | AuditDataDTO |
None. |
|
| Entities | Collection of IPersonDTO |
None. |
|
| DatabaseCount | integer |
None. |
|
| Databases | Collection of OrganizationDatabaseDTO |
None. |
|
| DBID | integer |
None. |
|
| BusinessUnits | Collection of integer |
None. |
|
| AuthorizationGroups | Collection of integer |
None. |
|
| Groups | Collection of BusinessUnitChildDTO |
None. |
|
| Forms | Collection of UserSubAuthorization |
None. |
|
| NoteTypes | Collection of UserSubAuthorization |
None. |
|
| Privileges | Collection of integer |
None. |
|
| UIPrivileges | Collection of integer |
None. |
|
| Reports | Collection of integer |
None. |
|
| Summary | string |
None. |
|
| IntegrationSource | IntegrationSource |
None. |
|
| DateFormat | string |
None. |
|
| IsMilitaryTime | boolean |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-compressed-json
Sample:
Sample not available.