Help Page Home - User

PUT User

Update current user detail. To change the username / email address and password, please call their own separate methods .

Request Information

URI Parameters

Name	Description	Type	Additional information
WsAccessKey	The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access.	string	Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId	Specifies the file id of the file to perform the operation upon.	integer	Required

Body Parameters

UserDetail

Name	Description	Type	Additional information
Id	The user Id. Read-only. Set by system. Not required for update.	integer	None.
Username	The username or email address that you use to login. Read-only. Not required for update. To change the username, call ChangeUsername method.	string	None.
FirstName	First name / given name.	string	Required
LastName	Last name / family name.	string	None.
MobileNumber	Mobile #.	string	None.
Is2FAEnabled	Is two-factor authentication (2FA) enabled for this user account? Read-only field. To opt-in/out of 2FA, call the 2FA related methods.	boolean	None.
TimezoneId	User timezone id.	integer	None.
DateTimeFormatId	[DEPRECATED] User's date format.	byte	None.
NumberFormatId	[DEPRECATED] User's number format.	byte	None.
_links	Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server.	Collection of Link	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Username": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "MobileNumber": "sample string 5",
  "Is2FAEnabled": true,
  "TimezoneId": 7,
  "DateTimeFormatId": 64,
  "NumberFormatId": 64,
  "_links": []
}

application/xml, text/xml

Sample:

<UserDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links />
  <Id>1</Id>
  <Username>sample string 2</Username>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <MobileNumber>sample string 5</MobileNumber>
  <Is2FAEnabled>true</Is2FAEnabled>
  <TimezoneId>7</TimezoneId>
  <DateTimeFormatId>64</DateTimeFormatId>
  <NumberFormatId>64</NumberFormatId>
</UserDetail>

Response Information

Resource Description

BaseResponseModel

Name	Description	Type	Additional information
StatusMessage	Status message from the response (if any).	string	None.
_links	Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server.	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusMessage": "sample string 1",
  "_links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2",
      "method": "sample string 3",
      "title": "sample string 4"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2",
      "method": "sample string 3",
      "title": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<BaseResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
      <method>sample string 3</method>
      <title>sample string 4</title>
    </Link>
    <Link>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
      <method>sample string 3</method>
      <title>sample string 4</title>
    </Link>
  </_links>
  <StatusMessage>sample string 1</StatusMessage>
</BaseResponseModel>