POST {authenticationKey}/{version}/Accounts

Will create a new user in the system If a user already exists, the system will return status code 200 with a message stating that the user already exists.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
authenticationKey

string

None.

version

string

None.

Body Parameters

RegisterBindingModel
NameDescriptionTypeAdditional information
Password

string

Data type: Password

MustChangePasswordOnFirstLogin

boolean

None.

ContactInfo

IUserContactBindingModel

None.

CustomerID

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:
{
  "Password": "sample string 1",
  "MustChangePasswordOnFirstLogin": true,
  "ContactInfo": null,
  "CustomerID": 1,
  "UserName": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Office": "sample string 6",
  "Culture": "sample string 7",
  "CultureID": 8,
  "DefaultTimeZone": {
    "Id": "sample string 1",
    "BaseUtcOffset": "00:00:00.1234567",
    "DisplayName": "sample string 3"
  },
  "Activation": "2019-08-18T18:48:54.4794899-04:00",
  "Expiration": "2019-08-18T18:48:54.4794899-04:00",
  "JobTitle": "sample string 9",
  "IsDisabled": true
}

text/html

Sample:
{"Password":"sample string 1","MustChangePasswordOnFirstLogin":true,"ContactInfo":null,"CustomerID":1,"UserName":"sample string 3","FirstName":"sample string 4","LastName":"sample string 5","Office":"sample string 6","Culture":"sample string 7","CultureID":8,"DefaultTimeZone":{"Id":"sample string 1","BaseUtcOffset":"00:00:00.1234567","DisplayName":"sample string 3"},"Activation":"2019-08-18T18:48:54.4794899-04:00","Expiration":"2019-08-18T18:48:54.4794899-04:00","JobTitle":"sample string 9","IsDisabled":true}

application/xml, text/xml

Sample:
<RegisterBindingModel 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-18T22:48:54.4794899Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </Activation>
  <Culture>sample string 7</Culture>
  <CultureID>8</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-18T22:48:54.4794899Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </Expiration>
  <FirstName>sample string 4</FirstName>
  <IsDisabled>true</IsDisabled>
  <JobTitle>sample string 9</JobTitle>
  <LastName>sample string 5</LastName>
  <Office>sample string 6</Office>
  <UserName>sample string 3</UserName>
  <ContactInfo i:nil="true" />
  <CustomerID>1</CustomerID>
  <MustChangePasswordOnFirstLogin>true</MustChangePasswordOnFirstLogin>
  <Password>sample string 1</Password>
</RegisterBindingModel>

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 'RegisterBindingModel'.

application/bson

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

Response Information

Resource Description

SystemUserModel

SystemUserModel
NameDescriptionTypeAdditional information
PublicKey

globally unique identifier

Required

LastLoginDate

date

None.

EffectivePermissions

Collection of OutputAssignedPermissionModel

None.

CustomerID

integer

None.

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.

Response Formats

application/json, text/json

Sample:
{
  "PublicKey": "c2aa0870-629a-4c54-ae3b-4d1fad13d592",
  "LastLoginDate": "2019-08-18T18:48:54.5419845-04:00",
  "EffectivePermissions": [
    {
      "DisplayName": "sample string 1",
      "Name": "sample string 2",
      "Tag": "sample string 3"
    }
  ],
  "CustomerID": 1,
  "LockoutEnabled": true,
  "LockoutEndDate": "2019-08-18T18:48:54.5419845-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": 2,
  "UserName": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Office": "sample string 6",
  "Culture": "sample string 7",
  "CultureID": 8,
  "DefaultTimeZone": {
    "Id": "sample string 1",
    "BaseUtcOffset": "00:00:00.1234567",
    "DisplayName": "sample string 3"
  },
  "Activation": "2019-08-18T18:48:54.5419845-04:00",
  "Expiration": "2019-08-18T18:48:54.5419845-04:00",
  "JobTitle": "sample string 9",
  "IsDisabled": true
}

text/html

Sample:
{"PublicKey":"c2aa0870-629a-4c54-ae3b-4d1fad13d592","LastLoginDate":"2019-08-18T18:48:54.5419845-04:00","EffectivePermissions":[{"DisplayName":"sample string 1","Name":"sample string 2","Tag":"sample string 3"}],"CustomerID":1,"LockoutEnabled":true,"LockoutEndDate":"2019-08-18T18:48:54.5419845-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":2,"UserName":"sample string 3","FirstName":"sample string 4","LastName":"sample string 5","Office":"sample string 6","Culture":"sample string 7","CultureID":8,"DefaultTimeZone":{"Id":"sample string 1","BaseUtcOffset":"00:00:00.1234567","DisplayName":"sample string 3"},"Activation":"2019-08-18T18:48:54.5419845-04:00","Expiration":"2019-08-18T18:48:54.5419845-04:00","JobTitle":"sample string 9","IsDisabled":true}

application/xml, text/xml

Sample:
<SystemUserModel 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-18T22:48:54.5419845Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </Activation>
  <Culture>sample string 7</Culture>
  <CultureID>8</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-18T22:48:54.5419845Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </Expiration>
  <FirstName>sample string 4</FirstName>
  <IsDisabled>true</IsDisabled>
  <JobTitle>sample string 9</JobTitle>
  <LastName>sample string 5</LastName>
  <Office>sample string 6</Office>
  <UserName>sample string 3</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-18T22:48:54.5419845Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </LockoutEndDate>
  <UserID>2</UserID>
  <CustomerID>1</CustomerID>
  <EffectivePermissions>
    <OutputAssignedPermissionModel>
      <Name>sample string 2</Name>
      <Tag>sample string 3</Tag>
      <DisplayName>sample string 1</DisplayName>
    </OutputAssignedPermissionModel>
  </EffectivePermissions>
  <LastLoginDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2019-08-18T22:48:54.5419845Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </LastLoginDate>
  <PublicKey>c2aa0870-629a-4c54-ae3b-4d1fad13d592</PublicKey>
</SystemUserModel>

application/bson

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