Update User (PUT)
put
/rest/v19/users/{partyNumber}
This operation replaces the details of a user with an updated version of the user details. If your implementation has Oracle CPQ running in Oracle Fusion, this endpoint will replace the details of an existing user and will also create a new user if the Request URI references a user that does not already exist. Note: CPQ is standardizing v19 REST APIs with the PUT method. Beginning in v19, 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.
Request
Supported Media Types
- application/json
Path Parameters
-
partyNumber(required): string
Party Number of the user
Root Schema : user-request
Type:
Show Source
object
-
accessPermissions:
object Access Permissions
Title:
Access Permissions
Access Permissions of the 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 -
currency:
object Currency
Title:
Currency
Currency preference of user. Value holds currency code -
dateFormat:
object Date Format
Title:
Date Format
User preferred date time format -
email:
string
Title:
Email
Email of the user -
emailPassword:
boolean
Title:
Should email password?
Send an email containing the password to the email address specified in the email field. -
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 -
isApplicationAdminPermEnabled:
boolean
Title:
Application Administrator
Indicates whether user is an Application Administrator. -
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 -
isUserAdminPermEnabled:
boolean
Title:
Is User Admin Permission Enabled
Is User Admin 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 -
lastName:
string
Title:
Last Name
Last Name of the user -
login:
string
Title:
Login Id
Login Id of the user -
numberFormat:
object Number Format
Title:
Number Format
Preferred number format of user -
oauthClientId:
string
Title:
OAuth Client Id
Client Id of the OAuth client that has a 1-to-1 association with the user -
partnerLogin:
string
Title:
Partner Login
Partner Login -
password:
string
Title:
Password
The password that the user will use to log in to the site. -
phone:
string
Title:
Phone Number
Phone number of the user -
separateShipAddr:
boolean
Title:
Seperate Ship Address
Seperate Ship Address -
sfdcOrgId:
string
Title:
SFDC Organization ID
SFDC Organization ID -
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
Nested Schema : Access Permissions
Type:
object
Title:
Access Permissions
Access Permissions of the user
Show Source
Nested Schema : Currency
Type:
object
Title:
Currency
Currency preference of user. Value holds currency code
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Date Format
Type:
object
Title:
Date Format
User preferred date time format
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value.
Nested Schema : Enabled For SSO
Type:
object
Title:
Enabled For SSO
Enabled For SSO
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Language
Type:
object
Title:
Language
Language preference of user. Value holds language code
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Number Format
Type:
object
Title:
Number Format
Preferred number format of user
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value.
Nested Schema : Status
Type:
object
Title:
Status
Status of the user
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value.
Nested Schema : TimeZone of user
Type:
object
Title:
TimeZone of user
User preferred timezone
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value.
Nested Schema : Type
Type:
object
Title:
Type
Type of the user
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Units
Type:
object
Title:
Units
User preferred units
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Access Permission
Title:
Access Permission
User access bits information
Nested Schema : Access Permission
Type:
object
Title:
Access Permission
User access bits information
Show Source
-
hasAccess:
boolean
Title:
Has Access
Flag to determine if 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
Nested Schema : Group Details
Type:
object
Title:
Show Source
Group Details
-
company:
object Company Details
Title:
Company Details
Company details to which the group belongs. -
description:
string
Title:
Description
Description of the group. -
label:
string
Title:
Label
Label of the group. -
links:
array Links to the related objects
Title:
Links to the related objects
Links to the related objects -
readOnly:
boolean
Title:
ReadOnly
Is read only group? -
segments:
object Segments
Title:
Segments
Access Segments for a group -
status:
object Status
Title:
Status
Status of the group. -
type:
object Type
Title:
Type
Type of the group. -
users:
object Users
Title:
Users
All users of a group -
variableName:
string
Title:
VariableName
Group variable name.
Nested Schema : Company Details
Type:
object
Title:
Company Details
Company details to which the group belongs.
Show Source
-
loginName:
string
Title:
Company Login Name
Company login name. -
name:
string
Title:
Company Name
Company name.
Nested Schema : Links to the related objects
Type:
array
Title:
Links to the related objects
Links to the related objects
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Segments
Type:
object
Title:
Segments
Access Segments for a group
Show Source
-
items:
array items
-
links:
array Links to the related objects
Title:
Links to the related objects
Links to the related objects
Nested Schema : Status
Type:
object
Title:
Status
Status of the group.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value.
Nested Schema : Type
Type:
object
Title:
Type
Type of the group.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value.
Nested Schema : Users
Type:
object
Title:
Users
All users of a group
Show Source
-
items:
array items
-
links:
array Links
Title:
Links
Links to the related objects.
Nested Schema : reference links
Type:
object
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
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
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Segment Details
Title:
Segment Details
Nested Schema : Links to the related objects
Type:
array
Title:
Links to the related objects
Links to the related objects
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Segment Details
Type:
object
Title:
Show Source
Segment Details
-
checked:
boolean
Title:
Checked
Is segment enabled. -
icon:
string
Title:
Icon
Path of the icon image file. This field is only applicable if uiMetadata is set as true. -
segments:
object Sub Segments
Title:
Sub Segments
Sub access segments for the segment. -
status:
integer
Title:
Status
Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true. -
variableName(required):
string
Title:
VariableName
Segment variable name.
Nested Schema : Sub Segments
Type:
object
Title:
Sub Segments
Sub access segments for the segment.
Show Source
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Sub Segment Details
Title:
Sub Segment Details
Nested Schema : Sub Segment Details
Type:
object
Title:
Show Source
Sub Segment Details
-
checked:
boolean
Title:
Checked
Is segment enabled. -
icon:
string
Title:
Icon
Path of the icon image file. This field is only applicable if uiMetadata is set as true. -
status:
integer
Title:
Status
Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true. -
title:
string
Title:
title
Segment label. -
variableName(required):
string
Title:
VariableName
Segment variable name.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object User Details
Title:
User Details
User details of group.
Nested Schema : Links
Type:
array
Title:
Links
Links to the related objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : User Details
Type:
object
Title:
User Details
User details of group.
Show Source
-
firstName:
string
Title:
User First Name
First name of the user. -
lastName:
string
Title:
User Last Name
Last name of the user. -
login:
string
Title:
User Login Id
Login Id of the user.
Response
Supported Media Types
- application/json
Default Response
Updated User details
Root Schema : User Details
Type:
object
Title:
User Details
User details of group.
Show Source
-
firstName:
string
Title:
User First Name
First name of the user. -
lastName:
string
Title:
User Last Name
Last name of the user. -
login:
string
Title:
User Login Id
Login Id of the user.