Update all properties of a user
put
/learn.rest/v1/users/{userId}
Request
Supported Media Types
- application/json
Path Parameters
-
userId: number
Unique identifier of User.
User object that needs to be updated
Root Schema : User
Type:
Show Source
object
-
city(optional):
string
The city of the user.
-
company(optional):
string
The User's place of work.
-
country(optional):
string
The country of the user.
-
department(optional):
string
The User's department.
-
email(optional):
string
The User's email address.
-
email2(optional):
string
The secondary email address.
-
employeeId(optional):
string
Email address of the employee.
-
fax(optional):
string
The fax number of the user.
-
firstName(optional):
string
Description of the user.
-
gender(optional):
string
Allowed Values:
[ "male", "female" ]
User gender. Enum for gender are: male, female -
includeInSearchFlag(optional):
boolean
Default Value:
false
Whether the user created should be visible in searches -
jobTitle(optional):
string
The User's job title.
-
lastName(optional):
string
Description of the user.
-
managerName(optional):
string
The User's manager's name.
-
officeName(optional):
string
The User's office.
-
pager(optional):
string
The pager number of the user.
-
pagerInteractive(optional):
string
The User's interactive pager number.
-
participatesInDaylight(optional):
boolean
Default Value:
true
Whether the user's timezone should observe daylight savings -
passwordValidUntilDate(optional):
string
The date until which the password is valid.
-
phoneDaytime(optional):
string
The day time number of the user.
-
phoneEvening(optional):
string
The evening number of the user.
-
phoneMobile(optional):
string
The mobile number of the user.
-
postalCode(optional):
string
The postal code of the user.
-
profession(optional):
string
-
ssn(optional):
string
The user's social security number.
-
state(optional):
string
The state of the user.
-
street1(optional):
string
The street text address of the user.
-
street2(optional):
string
The street text address of the user.
-
timeZone(optional):
string
The timezone for the user
-
username(optional):
string
Username of the user
Example:
{
"username":"cwallace",
"firstName":"Chris",
"lastName":"Wallace",
"street1":"500 Oracle Parkway",
"street2":"suite 500",
"city":"Redwood Shores",
"state":"CA",
"postalCode":"94065",
"country":"US",
"officeName":"HQ",
"gender":"male",
"includeInSearchFlag":true,
"jobTitle":"Product Manager",
"managerName":"n/a",
"pagerInteractive":"n/a",
"ssn":"n/a",
"email2":"n/a",
"pager":"n/a",
"company":"Oracle",
"fax":"n/a",
"department":"Product Development",
"phoneEvening":"n/a",
"email":"info@oracle.com",
"phoneDaytime":"+1.650.506.7000",
"profession":"Product Management",
"phoneMobile":"+1.800.392.2999",
"employeeId":"n/a",
"passwordValidUntilDate":"2016-10-12T11:00:00-04:00",
"timeZone":"Eastern Standard Time",
"participatesInDaylight":true
}
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/xml
- application/json
200 Response
Resource updated.
400 Response
Request has incorrect syntax or does not contain a field that is required.
401 Response
404 Response
Resource not found.
500 Response
Internal server error.