Replace User Details
put
/rest/v7/companies/{companyName}/users/{userName}
This operation replaces the details of an existing user or creates a new user. If the Request URI references an existing user, the existing user details are replaced with an updated version of the user details. If the Request URI references a user that does not already exist, a new user is created.
Request
Supported Media Types
- application/json
Path Parameters
-
companyName: string
Company name of the user. For Host Company users, use _host. For Partner Organization users, use partner organization company name.
-
userName: string
Login Id of the user
Root Schema : user
Type:
Show Source
object
-
approvalDelegate(optional):
string
Title:
Approval Delegate
The approval delegate associated with the user -
billAddress1(optional):
string
Title:
Billing Address 1
The billing address -
billAddress2(optional):
string
Title:
Billing Address 2
Addtional billing address -
billCity(optional):
string
Title:
Billing City
The billing city -
billCompany(optional):
string
Title:
Billing Company
The billing company -
billCompany2(optional):
string
Title:
Billing Company 2
Additional billing company -
billCountry(optional):
string
Title:
Billing Country
The billing country -
billEmail(optional):
string
Title:
Billing Email
The billing email address -
billFax(optional):
string
Title:
Billing Fax
The billing fax number -
billFirstName(optional):
string
Title:
Billing First Name
The billing first name -
billLastName(optional):
string
Title:
Billing Last Name
The billing last name -
billPhone(optional):
string
Title:
Billing Phone
The billing phone number -
billStateProvince(optional):
string
Title:
Billing State
The billing state -
billZip(optional):
string
Title:
Billing Zip
The billing zip code -
companyId(optional):
integer
Title:
Company ID
The company ID to associate with the user -
currency(optional):
integer
Title:
Currency ID
The preferred Currency ID of the user -
currencyCode(optional):
string
Title:
Currency Code
The preferred Currency Code of the user -
datePrefId(optional):
integer
Title:
Date Preference
The user?????????s date preference -
email(optional):
string
Title:
Email
The email address of the user -
enabledForSso(optional):
string
Title:
Enabled For SSO
The Single Sign-On information associated with the user -
externalSsoId(optional):
string
Title:
External SSO ID
The external Single Sign On ID to associate with the user -
fax(optional):
string
Title:
Fax Number
The fax of the user -
firstName(optional):
string
Title:
First Name
The first Name of the user -
id(optional):
integer
Title:
ID
The unique identifier of the user -
isAccessAdminPermEnabled(optional):
boolean
Is Access Admin permissions enabled? Yes = true, No = false
-
isNotifyEmail(optional):
boolean
Title:
Is Notification Preference Email
Is the notification preference email? Yes = true, No = false -
isNotifyFax(optional):
string
Title:
Is Notification Preference Fax
Is the notification preference fax? Yes = true, No = false -
isProxyPermEnabled(optional):
boolean
Title:
Proxy Permission Enabled
Are proxy permissions enabled? Yes = true, No = false -
isSuperUserPermEnabled(optional):
boolean
Title:
Is Superuser Permission Enabled
Is superuser permission enabled? Yes = true, No = false -
isWebServicesOnly(optional):
boolean
Title:
Web Services Only
Is Web Services Only enabled? Yes = true, No = false -
jobTitle(optional):
string
Title:
Job Title
The job Title of the user -
language(optional):
integer
Title:
Language ID
The preferred language ID of the user -
languageCode(optional):
string
Title:
Language Code
Preferred Language Code of the user -
lastName(optional):
string
Title:
Last Name
The last Name of the user -
login(optional):
string
Title:
Login ID
The login ID of the user -
numberFormatId(optional):
integer
Title:
Number Format ID
The number format ID -
phone(optional):
string
Title:
Phone Number
The phone number of the user -
separateShipAddr(optional):
boolean
Title:
Seperate Ship Address
Is there a separate shipping address for the user? Yes = true, No = false -
shipAddress1(optional):
string
Title:
Shipping Address 1
The shipping address -
shipAddress2(optional):
string
Title:
Shipping Address 2
Additional shipping address -
shipCity(optional):
string
Title:
Shipping City
The shipping city -
shipCompany(optional):
string
Title:
Shipping Company
The shipping company -
shipCompany2(optional):
string
Title:
Shipping Company 2
Additional shipping company -
shipCountry(optional):
string
Title:
Shipping Country
The shipping country -
shipEmail(optional):
string
Title:
Shipping Email
The shipping email -
shipFax(optional):
string
Title:
Shipping Fax
The shipping fax number -
shipFirstName(optional):
string
Title:
Shipping First Name
The shipping first name -
shipLastName(optional):
string
Title:
Shipping Last Name
The shipping last name -
shipPhone(optional):
string
Title:
Shipping Phone
SThe shipping phone number -
shipStateProvince(optional):
string
Title:
Shipping State
SThe shipping state -
shipZip(optional):
string
Title:
Shipping Zip
The shipping zip code -
status(optional):
integer
Title:
Status
The status of the user -
timeZone(optional):
string
Title:
Time Zone
The time zone of the user -
type(optional):
string
Title:
Type
The type of the user -
units(optional):
integer
Title:
Units
The user?????????s unit-type preference
Response
Supported Media Types
- application/json
Default Response
Root Schema : user
Type:
Show Source
object
-
approvalDelegate(optional):
string
Title:
Approval Delegate
The approval delegate associated with the user -
billAddress1(optional):
string
Title:
Billing Address 1
The billing address -
billAddress2(optional):
string
Title:
Billing Address 2
Addtional billing address -
billCity(optional):
string
Title:
Billing City
The billing city -
billCompany(optional):
string
Title:
Billing Company
The billing company -
billCompany2(optional):
string
Title:
Billing Company 2
Additional billing company -
billCountry(optional):
string
Title:
Billing Country
The billing country -
billEmail(optional):
string
Title:
Billing Email
The billing email address -
billFax(optional):
string
Title:
Billing Fax
The billing fax number -
billFirstName(optional):
string
Title:
Billing First Name
The billing first name -
billLastName(optional):
string
Title:
Billing Last Name
The billing last name -
billPhone(optional):
string
Title:
Billing Phone
The billing phone number -
billStateProvince(optional):
string
Title:
Billing State
The billing state -
billZip(optional):
string
Title:
Billing Zip
The billing zip code -
companyId(optional):
integer
Title:
Company ID
The company ID to associate with the user -
currency(optional):
integer
Title:
Currency ID
The preferred Currency ID of the user -
currencyCode(optional):
string
Title:
Currency Code
The preferred Currency Code of the user -
datePrefId(optional):
integer
Title:
Date Preference
The user?????????s date preference -
email(optional):
string
Title:
Email
The email address of the user -
enabledForSso(optional):
string
Title:
Enabled For SSO
The Single Sign-On information associated with the user -
externalSsoId(optional):
string
Title:
External SSO ID
The external Single Sign On ID to associate with the user -
fax(optional):
string
Title:
Fax Number
The fax of the user -
firstName(optional):
string
Title:
First Name
The first Name of the user -
id(optional):
integer
Title:
ID
The unique identifier of the user -
isAccessAdminPermEnabled(optional):
boolean
Is Access Admin permissions enabled? Yes = true, No = false
-
isNotifyEmail(optional):
boolean
Title:
Is Notification Preference Email
Is the notification preference email? Yes = true, No = false -
isNotifyFax(optional):
string
Title:
Is Notification Preference Fax
Is the notification preference fax? Yes = true, No = false -
isProxyPermEnabled(optional):
boolean
Title:
Proxy Permission Enabled
Are proxy permissions enabled? Yes = true, No = false -
isSuperUserPermEnabled(optional):
boolean
Title:
Is Superuser Permission Enabled
Is superuser permission enabled? Yes = true, No = false -
isWebServicesOnly(optional):
boolean
Title:
Web Services Only
Is Web Services Only enabled? Yes = true, No = false -
jobTitle(optional):
string
Title:
Job Title
The job Title of the user -
language(optional):
integer
Title:
Language ID
The preferred language ID of the user -
languageCode(optional):
string
Title:
Language Code
Preferred Language Code of the user -
lastName(optional):
string
Title:
Last Name
The last Name of the user -
login(optional):
string
Title:
Login ID
The login ID of the user -
numberFormatId(optional):
integer
Title:
Number Format ID
The number format ID -
phone(optional):
string
Title:
Phone Number
The phone number of the user -
separateShipAddr(optional):
boolean
Title:
Seperate Ship Address
Is there a separate shipping address for the user? Yes = true, No = false -
shipAddress1(optional):
string
Title:
Shipping Address 1
The shipping address -
shipAddress2(optional):
string
Title:
Shipping Address 2
Additional shipping address -
shipCity(optional):
string
Title:
Shipping City
The shipping city -
shipCompany(optional):
string
Title:
Shipping Company
The shipping company -
shipCompany2(optional):
string
Title:
Shipping Company 2
Additional shipping company -
shipCountry(optional):
string
Title:
Shipping Country
The shipping country -
shipEmail(optional):
string
Title:
Shipping Email
The shipping email -
shipFax(optional):
string
Title:
Shipping Fax
The shipping fax number -
shipFirstName(optional):
string
Title:
Shipping First Name
The shipping first name -
shipLastName(optional):
string
Title:
Shipping Last Name
The shipping last name -
shipPhone(optional):
string
Title:
Shipping Phone
SThe shipping phone number -
shipStateProvince(optional):
string
Title:
Shipping State
SThe shipping state -
shipZip(optional):
string
Title:
Shipping Zip
The shipping zip code -
status(optional):
integer
Title:
Status
The status of the user -
timeZone(optional):
string
Title:
Time Zone
The time zone of the user -
type(optional):
string
Title:
Type
The type of the user -
units(optional):
integer
Title:
Units
The user?????????s unit-type preference
Examples
The following example shows how to replace user details by submitting a PUT request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X PUT - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v7/companies/{companyname}/users/AAP39
Request Body Sample
{ "login": "AAP39", "firstName": "AA39", "lastName": "PP39", "email": "service2@bigmachines.com", "status": 1, "type": "FULL_ACCESS", "enabledForSso": "NOT_ENABLED", "languageCode": "es_ES", "currencyCode": "GBP" }