PUT {authenticationKey}/{version}/Accounts/{userPublicKey}

Updates the user account.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userPublicKey

globally unique identifier

Required

authenticationKey

string

None.

version

string

None.

Body Parameters

UpdateUserModel
NameDescriptionTypeAdditional information
LockoutEnabled

boolean

None.

LockoutEndDate

date

None.

ContactInfo

UserContactBindingModel

None.

UserID

integer

None.

UserName

string

Required

String length: inclusive between 4 and 128

FirstName

string

Required

String length: inclusive between 1 and 256

LastName

string

Required

String length: inclusive between 1 and 256

Office

string

None.

Culture

string

String length: inclusive between 0 and 5

CultureID

integer

None.

DefaultTimeZone

TimeZoneModel

None.

Activation

date

Data type: DateTime

Expiration

date

Data type: DateTime

JobTitle

string

String length: inclusive between 0 and 256

IsDisabled

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "LockoutEnabled": true,
  "LockoutEndDate": "2019-08-18T21:18:24.353642-04:00",
  "ContactInfo": {
    "UserContactInformationID": 1,
    "Email": "sample string 2",
    "OfficeNumber": "sample string 3",
    "HomeNumber": "sample string 4",
    "MobileNumber": "sample string 5",
    "HomeAddress": {
      "Street1": "sample string 1",
      "Street2": "sample string 2",
      "City": "sample string 3",
      "StateProvinceRegion": "sample string 4",
      "PostalCode": "sample string 5",
      "Country": "sample string 6"
    },
    "BusinessAddress": {
      "Street1": "sample string 1",
      "Street2": "sample string 2",
      "City": "sample string 3",
      "StateProvinceRegion": "sample string 4",
      "PostalCode": "sample string 5",
      "Country": "sample string 6"
    }
  },
  "UserID": 1,
  "UserName": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Office": "sample string 5",
  "Culture": "sample string 6",
  "CultureID": 7,
  "DefaultTimeZone": {
    "Id": "sample string 1",
    "BaseUtcOffset": "00:00:00.1234567",
    "DisplayName": "sample string 3"
  },
  "Activation": "2019-08-18T21:18:24.353642-04:00",
  "Expiration": "2019-08-18T21:18:24.353642-04:00",
  "JobTitle": "sample string 8",
  "IsDisabled": true
}

text/html

Sample:
{"LockoutEnabled":true,"LockoutEndDate":"2019-08-18T21:18:24.353642-04:00","ContactInfo":{"UserContactInformationID":1,"Email":"sample string 2","OfficeNumber":"sample string 3","HomeNumber":"sample string 4","MobileNumber":"sample string 5","HomeAddress":{"Street1":"sample string 1","Street2":"sample string 2","City":"sample string 3","StateProvinceRegion":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"},"BusinessAddress":{"Street1":"sample string 1","Street2":"sample string 2","City":"sample string 3","StateProvinceRegion":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6"}},"UserID":1,"UserName":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","Office":"sample string 5","Culture":"sample string 6","CultureID":7,"DefaultTimeZone":{"Id":"sample string 1","BaseUtcOffset":"00:00:00.1234567","DisplayName":"sample string 3"},"Activation":"2019-08-18T21:18:24.353642-04:00","Expiration":"2019-08-18T21:18:24.353642-04:00","JobTitle":"sample string 8","IsDisabled":true}

application/xml, text/xml

Sample:
<UpdateUserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.Membership">
  <Activation xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2019-08-19T01:18:24.353642Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </Activation>
  <Culture>sample string 6</Culture>
  <CultureID>7</CultureID>
  <DefaultTimeZone xmlns:d2p1="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.Common">
    <d2p1:BaseUtcOffset>PT0.1234567S</d2p1:BaseUtcOffset>
    <d2p1:DisplayName>sample string 3</d2p1:DisplayName>
    <d2p1:Id>sample string 1</d2p1:Id>
  </DefaultTimeZone>
  <Expiration xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2019-08-19T01:18:24.353642Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </Expiration>
  <FirstName>sample string 3</FirstName>
  <IsDisabled>true</IsDisabled>
  <JobTitle>sample string 8</JobTitle>
  <LastName>sample string 4</LastName>
  <Office>sample string 5</Office>
  <UserName>sample string 2</UserName>
  <ContactInfo>
    <BusinessAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.Common">
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:PostalCode>sample string 5</d3p1:PostalCode>
      <d3p1:StateProvinceRegion>sample string 4</d3p1:StateProvinceRegion>
      <d3p1:Street1>sample string 1</d3p1:Street1>
      <d3p1:Street2>sample string 2</d3p1:Street2>
    </BusinessAddress>
    <Email>sample string 2</Email>
    <HomeAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.Common">
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:PostalCode>sample string 5</d3p1:PostalCode>
      <d3p1:StateProvinceRegion>sample string 4</d3p1:StateProvinceRegion>
      <d3p1:Street1>sample string 1</d3p1:Street1>
      <d3p1:Street2>sample string 2</d3p1:Street2>
    </HomeAddress>
    <HomeNumber>sample string 4</HomeNumber>
    <MobileNumber>sample string 5</MobileNumber>
    <OfficeNumber>sample string 3</OfficeNumber>
    <UserContactInformationID>1</UserContactInformationID>
  </ContactInfo>
  <LockoutEnabled>true</LockoutEnabled>
  <LockoutEndDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2019-08-19T01:18:24.353642Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </LockoutEndDate>
  <UserID>1</UserID>
</UpdateUserModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateUserModel'.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

IdentityResult

AuthenticationResult
NameDescriptionTypeAdditional information
Succeeded

boolean

None.

Errors

Collection of string

None.

ErrorCode

APIErrorCodes

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": 0,
  "Succeeded": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:
{"ErrorCode":0,"Succeeded":true,"Errors":["sample string 1","sample string 2"]}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.