Update/Create Company User
/rest/v16/companies/{companyName}/users/{userName}
Request
- application/json
-
companyName(required): string
Company login name. For Host Company users, use _host. For Partner Organization users, use partner organization company login name.
-
userName(required): string
Login Id of the user
object
User request model
-
active:
boolean
Title:
User status
Status of the User -
emails(required):
array Email
Title:
Email
Email of the User -
enterpriseUser(required):
object enterpriseUser
-
extensionUser(required):
object extensionUser
-
name(required):
object Name
Title:
Name
Full name of the user -
phoneNumbers:
array Phone Numbers
Title:
Phone Numbers
Phone numbers of the User -
preferredLanguage:
string
Title:
Preferred Language
Preferred language of the User -
timezone:
string
Title:
timezone
Time zone of the user -
title:
string
Title:
Job title of the User
Job title of the User -
userName(required):
string
Title:
Username
Login Name of the user
object
-
organization(required):
string
Title:
Organization
Company name of the user
object
-
addresses:
array addresses
-
approvalDelegate:
string
Title:
Approval Delegate
Approval Delegate -
currency:
string
Title:
Currency Code
Preferred Currency Code of the user -
dateFormat:
integer
Title:
Date Format Id
Date Format Id -
enabledForSso:
string
Title:
Enabled For SSO
Enabled For SSO -
externalSsoId:
string
Title:
externalSsoId
External SSO Id -
fax:
string
Title:
Fax Number
Fax of the user -
isAccessAdminPermEnabled:
boolean
Title:
Access Admin Permission Enabled
Access Admin Permission Enabled -
isNotifyEmail:
boolean
Title:
Is Notification Preference Email
Is Notification Preference Email -
isNotifyFax:
boolean
Title:
Is Notification Preference Fax
Is Notification preference Fax -
isProxyPermEnabled:
boolean
Title:
Proxy permission enabled
Proxy permission enabled -
isSuperUserPermEnabled:
boolean
Title:
Is Superuser Permission Enabled
Is Superuser Permission Enabled -
isWebServicesOnly:
boolean
Title:
Web Services Only
Web Services Only -
numberFormat:
integer
Title:
Number Format Id
Number Format Id -
partnerLogin:
string
Title:
Partner Login
Partner Login of the user -
SeparateShipAddr:
boolean
Title:
Separate ship address
Separate ship address -
sfdcOrgId:
string
Title:
Sfdc Organization ID
Sfdc Organization ID -
units:
integer
Title:
Units
Units -
userType:
string
Title:
Type of the user
Type of the user
object
Name
-
familyName:
string
Title:
FamilyName
Last Name of the user -
givenName(required):
string
Title:
GivenName
First name of the user
array
Phone Numbers
object
-
primary:
boolean
Title:
primary
Whether email is primary or not -
type:
string
Title:
type
Type of the email -
value(required):
string
Title:
value
value of the email
object
-
address1:
string
Title:
Shipping/Billing Address 1
Shipping/Billing Address 1 -
address2:
string
Title:
Shipping/Billing Address 2
Shipping/Billing Address 2 -
companyName:
string
Title:
Shipping/Billing Company
Shipping/Billing Company -
companyName2:
string
Title:
Shipping/Billing Company2
Shipping/Billing Company2 -
country:
string
Title:
Shipping/Billing Country
Shipping/Billing Country -
email:
string
Title:
Shipping/Billing Email
Shipping/Billing Email -
fax:
string
Title:
Shipping/Billing Fax
Shipping/Billing Fax -
locality:
string
Title:
Shipping/Billing Locality
Shipping/Billing Locality -
name:
object Shipping/Billing Full name
Title:
Shipping/Billing Full name
Shipping/Billing Full name -
phone:
string
Title:
Shipping/Billing Phone
Shipping/Billing Phone -
postalCode:
string
Title:
Shipping/Billing Postal Code
Shipping/Billing Postal Code -
region:
string
Title:
Shipping/Billing Region
Shipping/Billing Region -
type:
string
Title:
Address Type
Allowed Values:[ "BILL_TO", "SHIP_TO" ]
Address Type
object
Shipping/Billing Full name
-
familyName:
string
Title:
Shipping/Billing FamilyName
Shipping/Billing FamilyName -
givenName:
string
Title:
Shipping/Billing GivenName
Shipping/Billing GivenName
object
-
primary:
boolean
Title:
primary
Whether phone number is primary or not -
type:
string
Title:
type
Type of the phone number -
value:
string
Title:
value
value of the phone number
Response
- application/json
Default Response
object
-
accessPermissions:
object Access Permissions
Title:
Access Permissions
Access Permissions of a user -
approvalDelegate:
string
Title:
Approval Delegate
Approval Delegate -
billAddress1:
string
Title:
Billing Address 1
Billing Address 1 -
billAddress2:
string
Title:
Billing Address 2
Billing Address 2 -
billCity:
string
Title:
Billing City
Billing City -
billCompany:
string
Title:
Billing Company
Billing Company -
billCompany2:
string
Title:
Billing Company 2
Billing Company 2 -
billCountry:
string
Title:
Billing Country
Billing Country -
billEmail:
string
Title:
Billing Email
Billing Email -
billFax:
string
Title:
Billing Fax
Billing Fax -
billFirstName:
string
Title:
Billing First Name
Billing First Name -
billLastName:
string
Title:
Billing Last Name
Billing Last Name -
billPhone:
string
Title:
Billing Phone
Billing Phone -
billStateProvince:
string
Title:
Billing State
Billing State -
billZip:
string
Title:
Billing Zip
Billing Zip -
company:
object Company details
Title:
Company details
User Company details. Applicable only for Users Across Companies -
currency:
object Currency
Title:
Currency
Currency preference of user. Value holds currency code -
dateAdded:
string
Title:
Date Added
User creation date -
dateFormat:
object Date Format
Title:
Date Format
User preferred date time format -
dateModified:
string
Title:
Date Modified
User modified date -
email:
string
Title:
Email
Email of the user -
enabledForSso:
object Enabled For SSO
Title:
Enabled For SSO
Enabled For SSO -
externalSsoId:
string
Title:
External SSO Id
External SSO Id -
fax:
string
Title:
Fax Number
Fax of the user -
firstName:
string
Title:
First Name
First Name of the user -
groups:
object Groups
Title:
Groups
Groups to which the user belongs -
isAccessAdminPermEnabled:
boolean
Title:
Access Admin Permission Enabled
Access Admin Permission Enabled -
isMobileEnabled:
boolean
Title:
Is Mobile Enabled
Is Mobile Enabled -
isNotifyEmail:
boolean
Title:
Is Notification Preference Email
Is notification preference email -
isNotifyFax:
boolean
Title:
Is Notification Preference Fax
Is notification preference fax -
isProxyPermEnabled:
boolean
Title:
Proxy Permission Enabled
Proxy permission enabled -
isSuperUserPermEnabled:
boolean
Title:
Is Superuser Permission Enabled
Is Superuser Permission Enabled -
isWebServicesOnly:
boolean
Title:
Web Services Only
Web Services Only -
jobTitle:
string
Title:
Job Title
Job Title of the user -
language:
object Language
Title:
Language
Language preference of user. Value holds language code -
lastLogin:
string
Title:
Last Login Date
User last loggedin date -
lastName:
string
Title:
Last Name
Last Name of the user -
links:
array Links to the related objects
Title:
Links to the related objects
Links to the related objects -
login:
string
Title:
Login Id
Login Id of the user -
numberFormat:
object Number Format
Title:
Number Format
Preferred number format of user -
partnerLogin:
string
Title:
Partner Login
Partner Login -
phone:
string
Title:
Phone Number
Phone number of the user -
separateShipAddr:
boolean
Title:
Seperate Ship Address
Seperate Ship Address -
shipAddress1:
string
Title:
Shipping Address 1
Shipping Address 1 -
shipAddress2:
string
Title:
Shipping Address 2
Shipping Address 2 -
shipCity:
string
Title:
Shipping City
Shipping City -
shipCompany:
string
Title:
Shipping Company
Shipping Company -
shipCompany2:
string
Title:
Shipping Company 2
Shipping Company 2 -
shipCountry:
string
Title:
Shipping Country
Shipping Country -
shipEmail:
string
Title:
Shipping Email
Shipping Email -
shipFax:
string
Title:
Shipping Fax
Shipping Fax -
shipFirstName:
string
Title:
Shipping First Name
Shipping First Name -
shipLastName:
string
Title:
Shipping Last Name
Shipping Last Name -
shipPhone:
string
Title:
Shipping Phone
Shipping Phone -
shipStateProvince:
string
Title:
Shipping State
Shipping State -
shipZip:
string
Title:
Shipping Zip
Shipping Zip -
status:
object Status
Title:
Status
Status of the user -
timeZone:
object TimeZone of user
Title:
TimeZone of user
User preferred timezone -
type:
object Type
Title:
Type
Type of the user -
units:
object Units
Title:
Units
User preferred units
object
Access Permissions
object
Company details
-
loginName:
string
Title:
Company Login Name
Company Login Name -
name:
string
Title:
Company Name
Company Name
object
Currency
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
object
Date Format
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
object
Enabled For SSO
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
object
Language
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
array
Links to the related objects
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
object
Number Format
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
object
Status
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
object
TimeZone of user
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
object
Type
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
object
Units
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
array
-
Array of:
object Access Permission
Title:
Access Permission
User access bits information
object
Access Permission
-
hasAccess:
boolean
Title:
Has Access
Boolean attribute that indicates if a user has access to the restricted entity. -
name:
string
Title:
Restricted Entity Name
Name of the entity to which access restrictions apply -
type:
string
Title:
Type
Type of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder -
variableName:
string
Title:
Restricted Entity Variable Name
Variable name of the entity to which access restrictions apply
array
-
Array of:
object Group
Title:
Group
User group information
object
Group
-
label:
string
Title:
Group Name
Group name -
type:
string
Title:
Group Type
Type of the group -
variableName:
string
Title:
Group Variable Name
Variable name of the group
object
reference links
-
href:
string
Title:
URL to the related object
URL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current object
Default Value:self
Link Relationship to the current object
Examples
Note: CPQ is standardizing v12 REST APIs with the PUT method. Beginning in v12, any parameters that are not explicitly included in the request body will be set to the default value, including "isAccessAdminPremEnabled" and "isWebServicesOnly" properties. If you are not sending all parameters in the request to update a user, you should use the PATCH method to avoid clearing unspecified properties.
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. Submit a PUT request to the REST resource using cURL to perform this operation 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/v16/companies/abcCo/users/janedoe
Request Body Sample
{ "login": "janedoe", "firstName": "Jane", "lastName": "Doe", "jobTitle": "Developer", "email": "jane.doe@abcCo.com", "phone": "9999999999", "fax": "9999999999", "billLastName": "Bill Last Name", "billCompany": "Bill Company", "billCompany2": "Bill Company 2", "billAddress1": "Address1", "billAddress2": "Address2", "billCity": "City", "billStateProvince": "Illinois", "billZip": "23434", "billCountry": "United States", "billPhone": "457657657", "billFax": "657657", "billEmail": "billing@abcCo.com", "shipFirstName": "Super", "shipLastName": "User", "shipCompany": "B", "shipCompany2": "B", "shipAddress1": "Address", "shipAddress2": "Address", "shipCity": "City", "shipStateProvince": "California", "shipZip": "345435", "shipCountry": "United States", "shipPhone": "345435", "shipFax": "235435", "shipEmail": "shipping@abcCo.com", "partnerLogin": null, "separateShipAddr": false, "isNotifyEmail": true, "isNotifyFax": false, "type": { "value": "RESTRICTED_ACCESS", "displayValue": "RestrictedAccess" }, "language": { "value": "en_US", "displayValue": "English" }, "currency": { "value": "USD", "displayValue": "US Dollar" }, "numberFormat": { "value": 1, "displayValue": "####,##" }, "timeZone": { "value": "America/Los_Angeles", "displayValue": "(GMT-8:00 GMT-7:00) Los Angeles" }, "dateFormat": { "value": 16, "displayValue": "dd/MM/yyyy h:mm a" }, "status": { "value": 1, "displayValue": "Active" }, "enabledForSso": { "value": "SSO_ENABLED", "displayValue": "Enabled for SSO" } }