GET api/account/users?skip={skip}&take={take}&username={username}&email={email}&name={name}&surname={surname}&status={status}
Returns a list of users in one's own organization.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
skip | integer |
Default value is 0 |
|
take | integer |
Default value is 50 |
|
username | string |
None. |
|
string |
None. |
||
name | string |
None. |
|
surname | string |
None. |
|
status | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of AccountInfoDTOName | Description | Type | Additional information |
---|---|---|---|
Username |
Username should be of the form "name.surname". If there is a collision with an existing username, append a number, e.g. "name.username2", "name.username3" and so on. The default domain is "cpp.hr." Other verified domains in the AD directory can be used as well, in which case the username should be of the form "name.surname@domain". |
string |
None. |
User's email that the temporary password will be sent to. |
string |
None. |
|
GoogleLoginEmails |
Comma-separated list of Google e-mail addresses that can be used for the login. Each address has to be unique system-wide. |
string |
None. |
Name |
User's name. Optional. |
string |
None. |
OrganizationName |
Name of the organization that the user is logged on to. |
string |
None. |
Surname |
User's surname. Optional. |
string |
None. |
Status |
User's account status. |
AccountStatus |
None. |
Role |
User's role within the organization. |
AccountRole |
None. |
DepartmentId |
ID of the department that the user is restricted to. 0 if the user has no restrictions. |
integer |
None. |
DeparmentName |
Name of the department that the user is restricted to. null if the user has no restrictions. |
string |
None. |
AccountId |
Set (when fetching) or the desired (when setting) account ID. It is useful when adding legacy users that need to have the specified user ID to have that value explicitly set. In such cases, it must not conflict with existing account IDs. Must be below 5000. |
integer |
None. |
TranslationLanguage |
User's preferred UI language. Croatian by default. |
TranslationLanguage |
None. |
IsEnabled |
Is the user's account enabled. |
boolean |
None. |
Response Formats
application/json, text/json
[ { "Username": "sample string 1", "Email": "sample string 2", "GoogleLoginEmails": "sample string 3", "Name": "sample string 4", "OrganizationName": "sample string 5", "Surname": "sample string 6", "Status": 0, "Role": 0, "DepartmentId": 7, "DeparmentName": "sample string 8", "AccountId": 9, "TranslationLanguage": 0, "IsEnabled": true }, { "Username": "sample string 1", "Email": "sample string 2", "GoogleLoginEmails": "sample string 3", "Name": "sample string 4", "OrganizationName": "sample string 5", "Surname": "sample string 6", "Status": 0, "Role": 0, "DepartmentId": 7, "DeparmentName": "sample string 8", "AccountId": 9, "TranslationLanguage": 0, "IsEnabled": true } ]
text/html
[{"Username":"sample string 1","Email":"sample string 2","GoogleLoginEmails":"sample string 3","Name":"sample string 4","OrganizationName":"sample string 5","Surname":"sample string 6","Status":0,"Role":0,"DepartmentId":7,"DeparmentName":"sample string 8","AccountId":9,"TranslationLanguage":0,"IsEnabled":true},{"Username":"sample string 1","Email":"sample string 2","GoogleLoginEmails":"sample string 3","Name":"sample string 4","OrganizationName":"sample string 5","Surname":"sample string 6","Status":0,"Role":0,"DepartmentId":7,"DeparmentName":"sample string 8","AccountId":9,"TranslationLanguage":0,"IsEnabled":true}]
application/xml, text/xml
<ArrayOfAccountInfoDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs"> <AccountInfoDTO> <AccountId>9</AccountId> <DeparmentName>sample string 8</DeparmentName> <DepartmentId>7</DepartmentId> <Email>sample string 2</Email> <GoogleLoginEmails>sample string 3</GoogleLoginEmails> <IsEnabled>true</IsEnabled> <Name>sample string 4</Name> <OrganizationName>sample string 5</OrganizationName> <Role>SystemAdmin</Role> <Status>Enabled</Status> <Surname>sample string 6</Surname> <TranslationLanguage>Croatian</TranslationLanguage> <Username>sample string 1</Username> </AccountInfoDTO> <AccountInfoDTO> <AccountId>9</AccountId> <DeparmentName>sample string 8</DeparmentName> <DepartmentId>7</DepartmentId> <Email>sample string 2</Email> <GoogleLoginEmails>sample string 3</GoogleLoginEmails> <IsEnabled>true</IsEnabled> <Name>sample string 4</Name> <OrganizationName>sample string 5</OrganizationName> <Role>SystemAdmin</Role> <Status>Enabled</Status> <Surname>sample string 6</Surname> <TranslationLanguage>Croatian</TranslationLanguage> <Username>sample string 1</Username> </AccountInfoDTO> </ArrayOfAccountInfoDTO>