Get User Groups

get

/rest/v19/companies/{companyName}/users/{userName}/groups

This endpoints returns all groups assigned to specified user.

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

Default Response

Groups details.
Body ()
Root Schema : Groups
Type: object
Title: Groups
Groups to which the user belongs
Show Source
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

Examples

This endpoints returns all groups assigned to specified user by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET -H "Authorization: Bearer <token>" - H 
https://sitename.oracle.com/rest/v19/companies/_host/users/aavenkatbulk/groups

Response Body Sample

{
  "items": [{
      "label": "100k Parts",
      "variableName": "a100kparts",
      "type": "Sales"
    }, {
      "label": "Admin Access- Internal Users",
      "variableName": "adminAccessUsersOnly",
      "type": "Administrator"
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 2,
  "hasMore": false,
  "links": [{
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/users/aavenkatbulk"
    }, {
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/users/aavenkatbulk/groups"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/users/aavenkatbulk/groups?offset=0&limit=1000"
    }
  ]
}
Back to Top