Jump to

• Request
• Response
• Examples

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

Body ()

Root Schema : groups-updateRequest

Type: object

Show Source

• items: array Groups
  Title: Groups

  List of groups to which user should belong, user will be removed from the existing groups which are not passed in request.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of groups to which user should belong, user will be removed from the existing groups which are not passed in request.",
            "title":"Groups",
            "items":{
                "$ref":"#/definitions/group"
            }
        }
    }
}

Nested Schema : Groups

Type: array

Title: Groups

List 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
  Title: Group

  User group information

{
    "type":"array",
    "description":"List of groups to which user should belong, user will be removed from the existing groups which are not passed in request.",
    "title":"Groups",
    "items":{
        "$ref":"#/definitions/group"
    }
}

Nested Schema : Group

Type: object

Title: Group

User group information

Show Source

• 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

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"Group name",
            "title":"Group Name"
        },
        "variableName":{
            "type":"string",
            "description":"Variable name of the group",
            "title":"Group Variable Name"
        },
        "type":{
            "type":"string",
            "description":"Type of the group",
            "title":"Group Type"
        }
    },
    "title":"Group",
    "description":"User group information"
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

User groups details.

Body ()

Root Schema : Groups

Type: object

Title: Groups

Groups to which the user belongs

Show Source

• items: array items
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/group"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Groups",
    "description":"Groups to which the user belongs"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Group
  Title: Group

  User group information

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/group"
    }
}

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

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : Group

Type: object

Title: Group

User group information

Show Source

• 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

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"Group name",
            "title":"Group Name"
        },
        "variableName":{
            "type":"string",
            "description":"Variable name of the group",
            "title":"Group Variable Name"
        },
        "type":{
            "type":"string",
            "description":"Type of the group",
            "title":"Group Type"
        }
    },
    "title":"Group",
    "description":"User group information"
}

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
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

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"
    }
  ]
}

Back to Top