Update Company User
patch
                    /rest/v19/companies/{companyName}/users/{userName}
This operation applies changes to an existing user.
                
                Request
Supported Media Types
                - application/json
Path Parameters
                - 
                    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
Root Schema : user-request
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        object- 
            accessPermissions: 
            object  Access Permissions
            
            Title:Access PermissionsAccess Permissions of the user
- 
            approvalDelegate: 
            string
            Title:Approval DelegateApproval Delegate
- 
            billAddress1: 
            string
            Title:Billing Address 1Billing Address 1
- 
            billAddress2: 
            string
            Title:Billing Address 2Billing Address 2
- 
            billCity: 
            string
            Title:Billing CityBilling City
- 
            billCompany: 
            string
            Title:Billing CompanyBilling Company
- 
            billCompany2: 
            string
            Title:Billing Company 2Billing Company 2
- 
            billCountry: 
            string
            Title:Billing CountryBilling Country
- 
            billEmail: 
            string
            Title:Billing EmailBilling Email
- 
            billFax: 
            string
            Title:Billing FaxBilling Fax
- 
            billFirstName: 
            string
            Title:Billing First NameBilling First Name
- 
            billLastName: 
            string
            Title:Billing Last NameBilling Last Name
- 
            billPhone: 
            string
            Title:Billing PhoneBilling Phone
- 
            billStateProvince: 
            string
            Title:Billing StateBilling State
- 
            billZip: 
            string
            Title:Billing ZipBilling Zip
- 
            currency: 
            object  Currency
            
            Title:CurrencyCurrency preference of user. Value holds currency code
- 
            dateFormat: 
            object  Date Format
            
            Title:Date FormatUser preferred date time format
- 
            email: 
            string
            Title:EmailEmail 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 SSOEnabled For SSO
- 
            externalSsoId: 
            string
            Title:External SSO IdExternal SSO Id
- 
            fax: 
            string
            Title:Fax NumberFax of the user
- 
            firstName: 
            string
            Title:First NameFirst Name of the user
- 
            groups: 
            object  Groups
            
            Title:GroupsGroups to which the user belongs
- 
            isAccessAdminPermEnabled: 
            boolean
            Title:Access Admin Permission EnabledAccess Admin Permission Enabled
- 
            isApplicationAdminPermEnabled: 
            boolean
            Title:Application AdministratorIndicates whether user is an Application Administrator.
- 
            isMobileEnabled: 
            boolean
            Title:Is Mobile EnabledIs Mobile Enabled
- 
            isNotifyEmail: 
            boolean
            Title:Is Notification Preference EmailIs notification preference email
- 
            isNotifyFax: 
            boolean
            Title:Is Notification Preference FaxIs notification preference fax
- 
            isProxyPermEnabled: 
            boolean
            Title:Proxy Permission EnabledProxy permission enabled
- 
            isUserAdminPermEnabled: 
            boolean
            Title:Is User Admin Permission EnabledIs User Admin Permission Enabled
- 
            isWebServicesOnly: 
            boolean
            Title:Web Services OnlyWeb Services Only
- 
            jobTitle: 
            string
            Title:Job TitleJob Title of the user
- 
            language: 
            object  Language
            
            Title:LanguageLanguage preference of user. Value holds language code
- 
            lastName: 
            string
            Title:Last NameLast Name of the user
- 
            login: 
            string
            Title:Login IdLogin Id of the user
- 
            numberFormat: 
            object  Number Format
            
            Title:Number FormatPreferred number format of user
- 
            oauthClientId: 
            string
            Title:OAuth Client IdClient Id of the OAuth client that has a 1-to-1 association with the user
- 
            partnerLogin: 
            string
            Title:Partner LoginPartner Login
- 
            password: 
            string
            Title:PasswordThe password that the user will use to log in to the site.
- 
            phone: 
            string
            Title:Phone NumberPhone number of the user
- 
            separateShipAddr: 
            boolean
            Title:Seperate Ship AddressSeperate Ship Address
- 
            sfdcOrgId: 
            string
            Title:SFDC Organization IDSFDC Organization ID
- 
            shipAddress1: 
            string
            Title:Shipping Address 1Shipping Address 1
- 
            shipAddress2: 
            string
            Title:Shipping Address 2Shipping Address 2
- 
            shipCity: 
            string
            Title:Shipping CityShipping City
- 
            shipCompany: 
            string
            Title:Shipping CompanyShipping Company
- 
            shipCompany2: 
            string
            Title:Shipping Company 2Shipping Company 2
- 
            shipCountry: 
            string
            Title:Shipping CountryShipping Country
- 
            shipEmail: 
            string
            Title:Shipping EmailShipping Email
- 
            shipFax: 
            string
            Title:Shipping FaxShipping Fax
- 
            shipFirstName: 
            string
            Title:Shipping First NameShipping First Name
- 
            shipLastName: 
            string
            Title:Shipping Last NameShipping Last Name
- 
            shipPhone: 
            string
            Title:Shipping PhoneShipping Phone
- 
            shipStateProvince: 
            string
            Title:Shipping StateShipping State
- 
            shipZip: 
            string
            Title:Shipping ZipShipping Zip
- 
            status: 
            object  Status
            
            Title:StatusStatus of the user
- 
            timeZone: 
            object  TimeZone of user
            
            Title:TimeZone of userUser preferred timezone
- 
            type: 
            object  Type
            
            Title:TypeType of the user
- 
            units: 
            object  Units
            
            Title:UnitsUser preferred units
Nested Schema : Access Permissions
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Access PermissionsAccess Permissions of the user
    
    
    
    
    Show Source
        
        
    
    
    
    
    
    
    
Nested Schema : Currency
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    CurrencyCurrency preference of user. Value holds currency code
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            string
            Title:ValueValue
Nested Schema : Date Format
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Date FormatUser preferred date time format
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            number
            Title:ValueValue.
Nested Schema : Enabled For SSO
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Enabled For SSOEnabled For SSO
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            string
            Title:ValueValue
Nested Schema : Language
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    LanguageLanguage preference of user. Value holds language code
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            string
            Title:ValueValue
Nested Schema : Number Format
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Number FormatPreferred number format of user
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            number
            Title:ValueValue.
Nested Schema : Status
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    StatusStatus of the user
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            number
            Title:ValueValue.
Nested Schema : TimeZone of user
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    TimeZone of userUser preferred timezone
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            number
            Title:ValueValue.
Nested Schema : Type
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    TypeType of the user
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            string
            Title:ValueValue
Nested Schema : Units
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    UnitsUser preferred units
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            number
            Title:ValueValue.
Nested Schema : items
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        array- 
            Array of: 
                object  Access Permission
            
            Title:Access PermissionUser access bits information
Nested Schema : Access Permission
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Access PermissionUser access bits information
    
    
    
    
    Show Source
        - 
            hasAccess: 
            boolean
            Title:Has AccessFlag to determine if user has access to the restricted entity
- 
            name: 
            string
            Title:Restricted Entity NameName of the entity to which access restrictions apply
- 
            type: 
            string
            Title:TypeType of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder
- 
            variableName: 
            string
            Title:Restricted Entity Variable NameVariable name of the entity to which access restrictions apply
Nested Schema : Group Details
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        Group Details- 
            company: 
            object  Company Details
            
            Title:Company DetailsCompany details to which the group belongs.
- 
            description: 
            string
            Title:DescriptionDescription of the group.
- 
            label: 
            string
            Title:LabelLabel of the group.
- 
            links: 
            array  Links to the related objects
            
            Title:Links to the related objectsLinks to the related objects
- 
            readOnly: 
            boolean
            Title:ReadOnlyIs read only group?
- 
            segments: 
            object  Segments
            
            Title:SegmentsAccess Segments for a group
- 
            status: 
            object  Status
            
            Title:StatusStatus of the group.
- 
            type: 
            object  Type
            
            Title:TypeType of the group.
- 
            users: 
            object  Users
            
            Title:UsersAll users of a group
- 
            variableName: 
            string
            Title:VariableNameGroup variable name.
Nested Schema : Company Details
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Company DetailsCompany details to which the group belongs.
    
    
    
    
    Show Source
        - 
            loginName: 
            string
            Title:Company Login NameCompany login name.
- 
            name: 
            string
            Title:Company NameCompany name.
Nested Schema : Links to the related objects
    
      
      Type: 
    
    
    
    arrayTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Links to the related objectsLinks to the related objects
    
    
    
    
    
        Show Source
        - 
            Array of: 
                object  reference links
            
            Title:reference linksReference links for the Parent, Self, Children and Related as applicable
Nested Schema : Segments
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    SegmentsAccess Segments for a group
    
    
    
    
    Show Source
        - 
            items: 
            array  items
            
            
- 
            links: 
            array  Links to the related objects
            
            Title:Links to the related objectsLinks to the related objects
Nested Schema : Status
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    StatusStatus of the group.
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            number
            Title:ValueValue.
Nested Schema : Type
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    TypeType of the group.
    
    
    
    
    Show Source
        - 
            displayValue: 
            string
            Title:Display ValueDisplay value.
- 
            value: 
            number
            Title:ValueValue.
Nested Schema : Users
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    UsersAll users of a group
    
    
    
    
    Show Source
        - 
            items: 
            array  items
            
            
- 
            links: 
            array  Links
            
            Title:LinksLinks to the related objects.
Nested Schema : reference links
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    reference linksReference links for the Parent, Self, Children and Related as applicable
    
    
    
    
    Show Source
        - 
            href: 
            string
            Title:URL to the related objectURL to the related object
- 
            name: 
            string
            
- 
            rel: 
            string
            Title:Link Relationship to the current objectDefault Value:selfLink 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: 
    
    
    
    arrayTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Links to the related objectsLinks to the related objects
    
    
    
    
    
        Show Source
        - 
            Array of: 
                object  reference links
            
            Title:reference linksReference links for the Parent, Self, Children and Related as applicable
Nested Schema : Segment Details
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        Segment Details- 
            checked: 
            boolean
            Title:CheckedIs segment enabled.
- 
            icon: 
            string
            Title:IconPath of the icon image file. This field is only applicable if uiMetadata is set as true.
- 
            segments: 
            object  Sub Segments
            
            Title:Sub SegmentsSub access segments for the segment.
- 
            status: 
            integer
            Title:StatusSpecifies 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:VariableNameSegment variable name.
Nested Schema : Sub Segments
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Sub SegmentsSub 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: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        Sub Segment Details- 
            checked: 
            boolean
            Title:CheckedIs segment enabled.
- 
            icon: 
            string
            Title:IconPath of the icon image file. This field is only applicable if uiMetadata is set as true.
- 
            status: 
            integer
            Title:StatusSpecifies 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:titleSegment label.
- 
            variableName(required): 
            string
            Title:VariableNameSegment variable name.
Nested Schema : items
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        array- 
            Array of: 
                object  User Details
            
            Title:User DetailsUser details of group.
Nested Schema : Links
    
      
      Type: 
    
    
    
    arrayTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    LinksLinks to the related objects.
    
    
    
    
    
        Show Source
        - 
            Array of: 
                object  reference links
            
            Title:reference linksReference links for the Parent, Self, Children and Related as applicable
Nested Schema : User Details
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    User DetailsUser details of group.
    
    
    
    
    Show Source
        - 
            firstName: 
            string
            Title:User First NameFirst name of the user.
- 
            lastName: 
            string
            Title:User Last NameLast name of the user.
- 
            login: 
            string
            Title:User Login IdLogin Id of the user.
Response
Supported Media Types
                - application/json
Default Response
Updated User details
                
                
                    Root Schema : User Details
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    User DetailsUser details of group.
    
    
    
    
    Show Source
        - 
            firstName: 
            string
            Title:User First NameFirst name of the user.
- 
            lastName: 
            string
            Title:User Last NameLast name of the user.
- 
            login: 
            string
            Title:User Login IdLogin Id of the user.
Examples
This operation applies changes to an existing user by submitting a PATCH request to the REST resource using curl -H "Authorization: Bearer <token>" For more information about cURL, see Use cURL.
curl - X PATCH -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/companies/abcCo/users/AAP39
Request Body Sample
{
  "type": {
    "value": "FULL_ACCESS",
    "displayValue": "FullAccess"
  },
  "language": {
    "value": "en_US",
    "displayValue": "English"
  },
  "currency": {
    "value": "USD",
    "displayValue": "US Dollar"
  },
  "status": {
    "value": 1,
    "displayValue": "Active"
  },
  "enabledForSso": {
    "value": "SSO_ENABLED",
    "displayValue": "Enabled for SSO"
  }
}
                  Note: The display value is optional in the sample above. For example, the following sample is also valid.
{
  "type": {
    "value": "FULL_ACCESS"
  },
  "language": {
    "value": "en_US"
  },
  "currency": {
    "value": "USD"
  },
  "status": {
    "value": 1
  },
  "enabledForSso": {
    "value": "SSO_ENABLED"
  }
}