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
Path Parameters
Body ()
Root Schema : user-request
Type: object
Show Source
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
Nested Schema : Date Format
Type: object
Title: Date Format
User preferred date time format
Show Source
Nested Schema : Enabled For SSO
Type: object
Title: Enabled For SSO
Enabled For SSO
Show Source
Nested Schema : Groups
Type: object
Title: Groups
Groups to which the user belongs
Show Source
Nested Schema : Language
Type: object
Title: Language
Language preference of user. Value holds language code
Show Source
Nested Schema : Number Format
Type: object
Title: Number Format
Preferred number format of user
Show Source
Nested Schema : Status
Type: object
Title: Status
Status of the user
Show Source
Nested Schema : TimeZone of user
Type: object
Title: TimeZone of user
User preferred timezone
Show Source
Nested Schema : Type
Type: object
Title: Type
Type of the user
Show Source
Nested Schema : Units
Type: object
Title: Units
User preferred units
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Access Permission
Type: object
Title: Access Permission
User access bits information
Show Source
  • Title: Has Access
    Flag to determine if user has access to the restricted entity
  • Title: Restricted Entity Name
    Name of the entity to which access restrictions apply
  • Title: Type
    Type of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder
  • Title: Restricted Entity Variable Name
    Variable name of the entity to which access restrictions apply
Nested Schema : items
Type: array
Show Source
Nested Schema : Group Details
Type: object
Title: Group Details
Show Source
Nested Schema : Company Details
Type: object
Title: Company Details
Company details to which the group belongs.
Show Source
Nested Schema : Segments
Type: object
Title: Segments
Access Segments for a group
Show Source
Nested Schema : Status
Type: object
Title: Status
Status of the group.
Show Source
Nested Schema : Type
Type: object
Title: Type
Type of the group.
Show Source
Nested Schema : Users
Type: object
Title: Users
All users of a group
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Segment Details
Type: object
Title: Segment Details
Show Source
  • Title: Checked
    Is segment enabled.
  • Title: Icon
    Path of the icon image file. This field is only applicable if uiMetadata is set as true.
  • Sub Segments
    Title: Sub Segments
    Sub access segments for the segment.
  • 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: 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: array
Show Source
Nested Schema : Sub Segment Details
Type: object
Title: Sub Segment Details
Show Source
  • Title: Checked
    Is segment enabled.
  • Title: Icon
    Path of the icon image file. This field is only applicable if uiMetadata is set as true.
  • 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: title
    Segment label.
  • Title: VariableName
    Segment variable name.
Nested Schema : items
Type: array
Show Source
Nested Schema : User Details
Type: object
Title: User Details
User details of group.
Show Source
Back to Top

Response

Supported Media Types

Default Response

Updated User details
Body ()
Root Schema : User Details
Type: object
Title: User Details
User details of group.
Show Source
Back to Top