Update User Groups
put
                    /rest/v19/companies/{companyName}/users/{userName}/groups
This operation to update assigned groups for the specified 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 : groups-updateRequest
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        object- 
            items: 
            array  Groups
            
            Title:GroupsList of groups to which user should belong, user will be removed from the existing groups which are not passed in request.
Nested Schema : Groups
    
      
      Type: 
    
    
    
    arrayTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    GroupsList of groups to which user should belong, user will be removed from the existing groups which are not passed in request.
    
    
    
    
    
        Show Source
        - 
            Array of: 
                object  Group Details
            
            Title:Group Details
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
User groups details.
                
                
                    Root Schema : Groups
    
      Type: 
      
    
    
    
    objectTitle: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    GroupsGroups to which the user belongs
    
    
    
    
    Show Source
        - 
            items: 
            array  items
            
            
- 
            links: 
            array  Links to the related objects
            
            Title:Links to the related objectsLinks to the related objects
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 : 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.
Examples
This operation to update assigned groups for the specified user by submitting a PUT request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X PUT -H "Authorization: Bearer <token>" - H https://sitename.oracle.com/rest/v19/companies/_host/users/aavenkatbulk/groups
Request Body Sample
{
  "items": [{
      "label": "Sales User",
      "variableName": "salesUser",
      "type": "Sales"
    }, {
      "label": "Sales Administrator",
      "variableName": "salesAdministrator",
      "type": "Administrator"
    }
  ]
}
                  Response Body Sample
{
  "items": [{
      "label": "Sales User",
      "variableName": "salesUser",
      "type": "Sales"
    }, {
      "label": "Sales Administrator",
      "variableName": "salesAdministrator",
      "type": "Administrator"
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/users/aavenkatbulk/groups"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/users/aavenkatbulk"
    }
  ]
}