PUT api/v1/admin/users/{id}
Updates user details of the specified user. The logged in user must have permission to perform this action.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The ID of the user to be modified. |
globally unique identifier |
Required |
Body Parameters
The new details of the user.
UserName | Description | Type | Additional information |
---|---|---|---|
ID |
The unique identifier for the user. |
globally unique identifier |
None. |
AgreementDate |
The date the user accepted the privacy policy and data processing agreement. This field is read-only. |
date |
None. |
AccountID |
The unique identifier for the account. |
globally unique identifier |
None. |
AdminUser |
Determines if the user is an admin user. |
boolean |
None. |
DateCreated |
The date the user account was created. |
date |
None. |
DateModified |
The date the user account was last modified. |
date |
None. |
DeclineDate |
The date the user declined the privacy policy and data processing agreement. This field is read-only. |
date |
None. |
DisplayName |
The name of the user. |
string |
Required |
DPAVersion |
The version of the data processing agreement that the user has accepted. This field is only read-only. |
string |
None. |
EmailAddress |
The email address of the user. |
string |
Required Data type: EmailAddress |
Enabled |
Determines the status of the user. |
boolean |
Required |
LanguageID |
The Id of the language of the user. |
globally unique identifier |
Required |
MobilePhone |
The mobile phone of the user |
string |
Required Matching regular expression pattern: ^(?=.*?\d.*?\d.*?\d.*?\d.*?\d)([+]?)([\d\s\(\)-]{5,20})$ |
Password |
The password of the user. |
string |
None. |
Pin |
Sets the security pin when two factor has been enable. Set it to null if you want it to randonly generate each login. |
string |
None. |
Preferences | Preferences |
None. |
|
PrivacyPolicyVersion |
The version of the privacy policy that the user has accepted. This field is only read-only. |
string |
None. |
SSOEnabled |
Determines if the user is part of a SSO setup. |
boolean |
None. |
TimeZone |
The timezone of the user. |
string |
Required |
Username |
The username of the user to log into the system. |
string |
Required |
Request Formats
application/json, text/json
{ "ID": "0ac0ddf7-337b-4029-89c3-ed21bc970325", "AgreementDate": "2024-09-08T00:57:39.7547117+00:00", "AccountID": "aca888ec-abe5-447c-8608-5507fc741b77", "AdminUser": true, "DateCreated": "2024-09-08T00:57:39.7547117+00:00", "DateModified": "2024-09-08T00:57:39.7547117+00:00", "DeclineDate": "2024-09-08T00:57:39.7547117+00:00", "DisplayName": "sample string 6", "DPAVersion": "sample string 7", "EmailAddress": "sample string 8", "Enabled": true, "LanguageID": "44d74610-7dad-490b-beee-d2fdd1498c44", "MobilePhone": "sample string 12", "Password": "sample string 13", "Pin": "sample string 14", "Preferences": 0, "PrivacyPolicyVersion": "sample string 15", "SSOEnabled": true, "TimeZone": "sample string 17", "Username": "sample string 18", "UserPassword": "sample string 19" }
application/xml, text/xml
<User xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ID>0ac0ddf7-337b-4029-89c3-ed21bc970325</ID> <AgreementDate>2024-09-08T00:57:39.7547117+00:00</AgreementDate> <AccountID>aca888ec-abe5-447c-8608-5507fc741b77</AccountID> <AdminUser>true</AdminUser> <DateCreated>2024-09-08T00:57:39.7547117+00:00</DateCreated> <DateModified>2024-09-08T00:57:39.7547117+00:00</DateModified> <DeclineDate>2024-09-08T00:57:39.7547117+00:00</DeclineDate> <DisplayName>sample string 6</DisplayName> <DPAVersion>sample string 7</DPAVersion> <EmailAddress>sample string 8</EmailAddress> <Enabled>true</Enabled> <LanguageID>44d74610-7dad-490b-beee-d2fdd1498c44</LanguageID> <Language>sample string 11</Language> <MobilePhone>sample string 12</MobilePhone> <Password>sample string 13</Password> <Pin>sample string 14</Pin> <Preferences>NONE</Preferences> <PrivacyPolicyVersion>sample string 15</PrivacyPolicyVersion> <SSOEnabled>true</SSOEnabled> <TimeZone>sample string 17</TimeZone> <Username>sample string 18</Username> <UserPassword>sample string 19</UserPassword> </User>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The modified user details.
ResponseOfUserName | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfUser |
None. |
Response Formats
application/json, text/json
{ "Error": { "ErrorCode": "sample string 1", "ErrorReason": "sample string 2" }, "ResponseData": { "Identification": { "UserId": "sample string 1" }, "Result": "sample string 1", "Detail": { "ID": "13f92565-c370-4d54-92ed-36b9840b2304", "AgreementDate": "2024-09-08T00:57:39.7547117+00:00", "AccountID": "3aebbe8b-de26-4f0e-970f-9cf753e0fea4", "AdminUser": true, "DateCreated": "2024-09-08T00:57:39.7547117+00:00", "DateModified": "2024-09-08T00:57:39.7547117+00:00", "DeclineDate": "2024-09-08T00:57:39.7547117+00:00", "DisplayName": "sample string 6", "DPAVersion": "sample string 7", "EmailAddress": "sample string 8", "Enabled": true, "LanguageID": "c590001b-a536-45eb-9541-2305e30bc705", "MobilePhone": "sample string 12", "Password": "sample string 13", "Pin": "sample string 14", "Preferences": 0, "PrivacyPolicyVersion": "sample string 15", "SSOEnabled": true, "TimeZone": "sample string 17", "Username": "sample string 18", "UserPassword": "sample string 19" } } }
application/xml, text/xml
<ResponseOfUser xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error> <ErrorCode>sample string 1</ErrorCode> <ErrorReason>sample string 2</ErrorReason> </Error> <ResponseData> <Result>sample string 1</Result> <Identification> <UserId>sample string 1</UserId> </Identification> <Detail> <ID>13f92565-c370-4d54-92ed-36b9840b2304</ID> <AgreementDate>2024-09-08T00:57:39.7547117+00:00</AgreementDate> <AccountID>3aebbe8b-de26-4f0e-970f-9cf753e0fea4</AccountID> <AdminUser>true</AdminUser> <DateCreated>2024-09-08T00:57:39.7547117+00:00</DateCreated> <DateModified>2024-09-08T00:57:39.7547117+00:00</DateModified> <DeclineDate>2024-09-08T00:57:39.7547117+00:00</DeclineDate> <DisplayName>sample string 6</DisplayName> <DPAVersion>sample string 7</DPAVersion> <EmailAddress>sample string 8</EmailAddress> <Enabled>true</Enabled> <LanguageID>c590001b-a536-45eb-9541-2305e30bc705</LanguageID> <Language>sample string 11</Language> <MobilePhone>sample string 12</MobilePhone> <Password>sample string 13</Password> <Pin>sample string 14</Pin> <Preferences>NONE</Preferences> <PrivacyPolicyVersion>sample string 15</PrivacyPolicyVersion> <SSOEnabled>true</SSOEnabled> <TimeZone>sample string 17</TimeZone> <Username>sample string 18</Username> <UserPassword>sample string 19</UserPassword> </Detail> </ResponseData> </ResponseOfUser>