PUT api/v1/user

Request Information

URI Parameters

None.

Body Parameters

PutUserRequest
NameDescriptionTypeAdditional information
SsoId

string

Required

AadObjectId

string

None.

UserName

string

None.

Email

string

None.

Phone

string

None.

GivenName

string

None.

Surname

string

None.

FullName

string

None.

Tenants

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "SsoId": "sample string 1",
  "AadObjectId": "sample string 2",
  "UserName": "sample string 3",
  "Email": "sample string 4",
  "Phone": "sample string 5",
  "GivenName": "sample string 6",
  "Surname": "sample string 7",
  "FullName": "sample string 8",
  "Tenants": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<PutUserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Request">
  <AadObjectId>sample string 2</AadObjectId>
  <Email>sample string 4</Email>
  <FullName>sample string 8</FullName>
  <GivenName>sample string 6</GivenName>
  <Phone>sample string 5</Phone>
  <SsoId>sample string 1</SsoId>
  <Surname>sample string 7</Surname>
  <Tenants xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tenants>
  <UserName>sample string 3</UserName>
</PutUserRequest>

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

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

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, multipart/form-data, image/png, image/jpg, image/jpeg, image/bmp

Sample:

Sample not available.