PUT api/admin/v1/users/{userId}

Update an existing user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

ID of the user

 integer

Required

Body Parameters

New user informations

UserEditDto
NameDescriptionTypeAdditional information
OrganizationalUnitId

User organizational unit (optional)

 integer

None
RoleId

User role (optional)

 integer

None
SupervisorId

Supervisor of the user (optional)

 integer

None
Code

Code for internal use, usefully for a synchronization with an external environment

 string

None
Login

Login of the user, must be unique

 string

None
Email

Email of the user

 string

None
FirstName

Firstname

 string

None
LastName

LastName

 string

None
FiscalCode

FiscalCode

 string

None
Vat

Vat

 string

None
Culture

Culture (EN-en, IT-It)

 string

None
FinalStatementEntryType

D = daily, P = period

 character

None
HomePage

Home page

 string

None
IsActive

True if the user is active, false otherwise

 boolean

None
ReceiveEmailNotification

True if the user want receive the emails

 boolean

None
ReceiveWebNotification

True if the user want receive the web alerts

 boolean

None
Id

Unique ID

 integer

None

Request Formats

application/json, text/json

Sample: 
{
  "OrganizationalUnitId": 1,
  "RoleId": 1,
  "SupervisorId": 1,
  "Code": "sample string 1",
  "Login": "sample string 2",
  "Email": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "FiscalCode": "sample string 6",
  "Vat": "sample string 7",
  "Culture": "sample string 8",
  "FinalStatementEntryType": "A",
  "HomePage": "sample string 10",
  "IsActive": true,
  "ReceiveEmailNotification": true,
  "ReceiveWebNotification": true,
  "Id": 14
}

application/xml, text/xml

Sample: 
<UserEditDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <Id>14</Id>
  <Code>sample string 1</Code>
  <Culture>sample string 8</Culture>
  <Email>sample string 3</Email>
  <FinalStatementEntryType>65</FinalStatementEntryType>
  <FirstName>sample string 4</FirstName>
  <FiscalCode>sample string 6</FiscalCode>
  <HomePage>sample string 10</HomePage>
  <IsActive>true</IsActive>
  <LastName>sample string 5</LastName>
  <Login>sample string 2</Login>
  <OrganizationalUnitId>1</OrganizationalUnitId>
  <ReceiveEmailNotification>true</ReceiveEmailNotification>
  <ReceiveWebNotification>true</ReceiveWebNotification>
  <RoleId>1</RoleId>
  <SupervisorId>1</SupervisorId>
  <Vat>sample string 7</Vat>
</UserEditDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

200

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None
Content

HttpContent

None
StatusCode

HttpStatusCode

None
ReasonPhrase

string

None
Headers

Collection of Object

None
RequestMessage

HttpRequestMessage

None
IsSuccessStatusCode

boolean

None