POST api/v1/user

Request Information

URI Parameters

None.

Body Parameters

UserRegistrationRequest
NameDescriptionTypeAdditional information
Username

string

Required

Matching regular expression pattern: [^\@]*

FirstName

string

Required

LastName

string

Required

Email

string

Required

Phone

string

None.

Password

string

Required

Tenant

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Username": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Email": "sample string 5",
  "Phone": "sample string 6",
  "Password": "sample string 7",
  "Tenant": "sample string 8"
}

application/xml, text/xml

Sample:
<UserRegistrationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Request">
  <Email>sample string 5</Email>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <Password>sample string 7</Password>
  <Phone>sample string 6</Phone>
  <Tenant>sample string 8</Tenant>
  <Username>sample string 2</Username>
</UserRegistrationRequest>

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

multipart/form-data

Sample:

An exception has occurred while using the formatter 'MultiPartMediaFormat' to generate sample for media type 'multipart/form-data'. Exception message: The media type formatter of type 'MultiPartMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/png

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/png'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpeg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpeg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/bmp

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/bmp'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

Response Information

Resource Description

UserRegistrationResponse
NameDescriptionTypeAdditional information
ID

string

None.

SsoId

string

None.

Username

string

None.

FirstName

string

None.

LastName

string

None.

Email

string

None.

Phone

string

None.

IsPFLUser

boolean

None.

EnableExport

boolean

None.

EnableUserManagement

boolean

None.

EnableMarketo

boolean

None.

_meta

ResponseMeta

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": "sample string 1",
  "SsoId": "sample string 2",
  "Username": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Email": "sample string 6",
  "Phone": "sample string 7",
  "IsPFLUser": true,
  "EnableExport": true,
  "EnableUserManagement": true,
  "EnableMarketo": true,
  "_meta": {
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "ChangeType": "Created"
  }
}

application/xml, text/xml

Sample:
<UserRegistrationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Response">
  <Email>sample string 6</Email>
  <EnableExport>true</EnableExport>
  <EnableMarketo>true</EnableMarketo>
  <EnableUserManagement>true</EnableUserManagement>
  <FirstName>sample string 4</FirstName>
  <ID>sample string 1</ID>
  <IsPFLUser>true</IsPFLUser>
  <LastName>sample string 5</LastName>
  <Phone>sample string 7</Phone>
  <SsoId>sample string 2</SsoId>
  <Username>sample string 3</Username>
  <_meta>
    <ChangeType>Created</ChangeType>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
  </_meta>
</UserRegistrationResponse>

multipart/form-data

Sample:

An exception has occurred while using the formatter 'MultiPartMediaFormat' to generate sample for media type 'multipart/form-data'. Exception message: The media type formatter of type 'MultiPartMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/png

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/png'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpeg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpeg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/bmp

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/bmp'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.