Jump to

• Request
• Response
• Examples

Get All Users of a Group

get

/rest/v19/companies/{companyLoginName}/groups/{groupVarName}/users

This endpoint retrieves a list of all users of a group.

Request

Path Parameters

• companyLoginName(required): string
  Company login name.
• groupVarName(required): string
  Group variable name.

Query Parameters

• excludeLinks: string
  Exclude given link types from response. Supported only with produces type application/json.

  Allowed Values: [ "self", "child", "parent", "canonical", "next", "prev", "related" ]
• fields: string
  User fields to be returned in response.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of fields to order the response by.
• q: string
  Criteria to filter the group users. By default no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

List of users for a group.

Body ()

Root Schema : Users

Type: object

Title: Users

All users of a group

Show Source

• items: array items
• links: array Links
  Title: Links

  Links to the related objects.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/user"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Users",
    "description":"All users of a group"
}

Nested Schema : items

Type: array

Show Source

• Array of: object User Details
  Title: User Details

  User details of group.

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

Nested Schema : Links

Type: array

Title: Links

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",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : User Details

Type: object

Title: User Details

User details of group.

Show Source

• firstName: string
  Title: User First Name

  First name of the user.
• lastName: string
  Title: User Last Name

  Last name of the user.
• login: string
  Title: User Login Id

  Login Id of the user.

{
    "type":"object",
    "properties":{
        "login":{
            "type":"string",
            "description":"Login Id of the user.",
            "title":"User Login Id"
        },
        "firstName":{
            "type":"string",
            "description":"First name of the user.",
            "title":"User First Name"
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the user.",
            "title":"User Last Name"
        }
    },
    "title":"User Details",
    "description":"User details of group."
}

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

  Default Value: self

  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",
            "default":"self"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

Examples

The following example retrieves a list of all users of a group by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/companies/visionServices/group/midwestTestGroup/users  

Response Body Sample

{
  "items": [{
      "login": "amayor",
      "firstName": "Alex",
      "lastName": "Mayor"
    }, {
      "login": "msmith",
      "firstName": "Matt",
      "lastName": "Smith"
    }, {
      "login": "ljones",
      "firstName": "Lisa",
      "lastName": "Jones"
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 3,
  "hasMore": false,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/groups/group1/users"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/groups/group1/users?offset=0&limit=1000"
    }
  ]
}

Back to Top