Child pages
  • Get Members
Skip to end of metadata
Go to start of metadata

Grouper Web Services

Description

Get members will retrieve subjects assigned to a group.

Features

  • Can base member list based on memberfilter (e.g. All, Immediate, Effective)
  • Lookup subjects by subject lookup (by id, source, identifier, etc)
  • Lookup groups by group lookup (by name or uuid)
  • Returns group / subject information, can be detailed or not
  • Can actAs another user
  • For 2.0+, you can pass in pointInTimeFrom and pointInTimeTo to get the member list at a certain point in time in the past, or in a date range.  This should be formatted: yyyy/MM/dd HH:mm:ss.SSS
  • In 2.1.3+ you can page or sort the results

Get members Lite service

  • Accepts one group to get members for
  • Documentation: SOAP (click on getMembersLite), REST (click on getMembersLite)
  • For REST, the request can put data in query string (in URL or request body)
  • REST request (colon is escaped to %3A): GET /grouper-ws/servicesRest/v1_3_000/groups/aStem%3AaGroup/members
    • Note: if passing data in request body e.g. actAs, use a POST
  • (see documentation above for details): Request object, response object
  • Response codes
  • Samples (all files with "Lite" in them, click on "download" to see file)

Get members service

  • No labels