PUT api/account
Updates user's profile information - e-mail, Name, Surname, Status or Role. The user is looked up by their username. AccountId can also be changed withing legacy account ID range ([1-5000]), if the user has a SystemAdmin role.
Request Information
URI Parameters
None.
Body Parameters
UpdateAccountDTOName | 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. |
Surname |
User's surname. Optional. |
string |
None. |
Status |
User's account status. Can be: Enabled, Disabled, Expired, NotPaid. |
string |
None. |
Role |
User's role within the organization. Can be: SystemAdmin, OrganizationAdmin, User, LightUser. |
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. |
DepartmentId |
Department ID that the user is restricted to. If 0, the user has no restrictions. |
integer |
None. |
Request Formats
application/json, text/json
{ "Username": "sample string 1", "Email": "sample string 2", "GoogleLoginEmails": "sample string 3", "Name": "sample string 4", "Surname": "sample string 5", "Status": "sample string 6", "Role": "sample string 7", "AccountId": 8, "TranslationLanguage": 0, "DepartmentId": 9 }
text/html
{"Username":"sample string 1","Email":"sample string 2","GoogleLoginEmails":"sample string 3","Name":"sample string 4","Surname":"sample string 5","Status":"sample string 6","Role":"sample string 7","AccountId":8,"TranslationLanguage":0,"DepartmentId":9}
application/xml, text/xml
<UpdateAccountDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs"> <AccountId>8</AccountId> <DepartmentId>9</DepartmentId> <Email>sample string 2</Email> <GoogleLoginEmails>sample string 3</GoogleLoginEmails> <Name>sample string 4</Name> <Role>sample string 7</Role> <Status>sample string 6</Status> <Surname>sample string 5</Surname> <TranslationLanguage>Croatian</TranslationLanguage> <Username>sample string 1</Username> </UpdateAccountDTO>
application/x-www-form-urlencoded
Response Information
Resource Description
UpdateAccountDTOName | 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. |
Surname |
User's surname. Optional. |
string |
None. |
Status |
User's account status. Can be: Enabled, Disabled, Expired, NotPaid. |
string |
None. |
Role |
User's role within the organization. Can be: SystemAdmin, OrganizationAdmin, User, LightUser. |
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. |
DepartmentId |
Department ID that the user is restricted to. If 0, the user has no restrictions. |
integer |
None. |
Response Formats
application/json, text/json
{ "Username": "sample string 1", "Email": "sample string 2", "GoogleLoginEmails": "sample string 3", "Name": "sample string 4", "Surname": "sample string 5", "Status": "sample string 6", "Role": "sample string 7", "AccountId": 8, "TranslationLanguage": 0, "DepartmentId": 9 }
text/html
{"Username":"sample string 1","Email":"sample string 2","GoogleLoginEmails":"sample string 3","Name":"sample string 4","Surname":"sample string 5","Status":"sample string 6","Role":"sample string 7","AccountId":8,"TranslationLanguage":0,"DepartmentId":9}
application/xml, text/xml
<UpdateAccountDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs"> <AccountId>8</AccountId> <DepartmentId>9</DepartmentId> <Email>sample string 2</Email> <GoogleLoginEmails>sample string 3</GoogleLoginEmails> <Name>sample string 4</Name> <Role>sample string 7</Role> <Status>sample string 6</Status> <Surname>sample string 5</Surname> <TranslationLanguage>Croatian</TranslationLanguage> <Username>sample string 1</Username> </UpdateAccountDTO>