GET api/Users?page={page}&rows={rows}
Get user list
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
page |
Optional - Current page of results wanted. Default is 1 |
integer |
Default value is 1 |
rows |
Optional - Current number of rows returned. Deafult is 100 |
integer |
Default value is 100 |
Body Parameters
None.
Response Information
Resource Description
UserAPIName | Description | Type | Additional information |
---|---|---|---|
Page |
Current page of data returned |
integer |
None. |
PerPage |
Users returned per page |
integer |
None. |
TotalCount |
Total count of all users |
integer |
None. |
PageCount |
Total count of pages containing user data |
integer |
None. |
Users |
User collection |
Collection of User |
None. |
Response Formats
application/json, text/json
Sample:
{ "Page": 1, "PerPage": 2, "TotalCount": 3, "PageCount": 4, "Users": [ { "ID": 1, "DateCreated": "2025-04-03T23:10:44.5936477-05:00", "DateModified": "2025-04-03T23:10:44.5936477-05:00", "Username": "sample string 4", "FirstName": "sample string 5", "LastName": "sample string 6", "Active": true, "LastLogin": "2025-04-03T23:10:44.5936477-05:00", "AccountLocked": true, "FailedLoginAttempts": 10, "Entitlement": "sample string 11" }, { "ID": 1, "DateCreated": "2025-04-03T23:10:44.5936477-05:00", "DateModified": "2025-04-03T23:10:44.5936477-05:00", "Username": "sample string 4", "FirstName": "sample string 5", "LastName": "sample string 6", "Active": true, "LastLogin": "2025-04-03T23:10:44.5936477-05:00", "AccountLocked": true, "FailedLoginAttempts": 10, "Entitlement": "sample string 11" } ] }
application/xml, text/xml
Sample:
<UserAPI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fhlbi_api.API"> <Page>1</Page> <PageCount>4</PageCount> <PerPage>2</PerPage> <TotalCount>3</TotalCount> <Users> <User> <AccountLocked>true</AccountLocked> <Active>true</Active> <DateCreated>2025-04-03T23:10:44.5936477-05:00</DateCreated> <DateModified>2025-04-03T23:10:44.5936477-05:00</DateModified> <Entitlement>sample string 11</Entitlement> <FailedLoginAttempts>10</FailedLoginAttempts> <FirstName>sample string 5</FirstName> <ID>1</ID> <LastLogin>2025-04-03T23:10:44.5936477-05:00</LastLogin> <LastName>sample string 6</LastName> <Username>sample string 4</Username> </User> <User> <AccountLocked>true</AccountLocked> <Active>true</Active> <DateCreated>2025-04-03T23:10:44.5936477-05:00</DateCreated> <DateModified>2025-04-03T23:10:44.5936477-05:00</DateModified> <Entitlement>sample string 11</Entitlement> <FailedLoginAttempts>10</FailedLoginAttempts> <FirstName>sample string 5</FirstName> <ID>1</ID> <LastLogin>2025-04-03T23:10:44.5936477-05:00</LastLogin> <LastName>sample string 6</LastName> <Username>sample string 4</Username> </User> </Users> </UserAPI>