Internet2 is investigating a security incident involving a compromise to a confluence server that affected https://spaces.at.internet2.edu on April 10, 2019, which was successfully mitigated on April 12, 2019. If you did not receive an email from us, it’s unlikely that any of the content you submitted to the Internet2 Spaces Wiki needs to be re-entered. We apologize for any inconvenience this may have caused. Should you have any questions or require further assistance, please email collaboration-support@internet2.edu.
Child pages
  • Get Memberships
Skip to end of metadata
Go to start of metadata

Grouper Web Services

Description

Get memberships will retrieve membership objects by group, by subject, or by id (or a combination).

Features

  • Can base membership 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
  • Can filter by a list name (currently only can return group members memberships, not privilege memberships)
  • Can filter by "scope" which is a sql "like" string in the namespace for group name.
  • Can filter for all memberships directly in a stem, or in any substem of a stem
  • Can filter by subject source so only people memberships are returned, or groups, or etc.
  • In v2.2+ you can pass in the serviceLookup (service name or id) and serviceRole (admin|user) to get the memberships of a service based on role.  This will essentially send you the users of a service.
  • In v2.1.5+ you can get privileges on groups, stems, attribute definitions.  You can pass in fieldType to filter on the type of memberships: list|access|naming|attributeDef
    • ownerStemNames, ownerStemUuids, ownerNamesOfAttributeDefs, ownerIdsOfAttributeDefs

Get memberships Lite service

  • Accepts one group, or one subject, or multiple membership ids to get members for (or combination)
  • Documentation: SOAP (click on getMembershipsLite), REST (click on getMembershipsLite)
  • 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_6_000/groups/aStem%3AaGroup/memberships
    • GET /grouper-ws/servicesRest/v1_6_000/subjects/12345/memberships
    • GET /grouper-ws/servicesRest/v1_6_000/memberships
    • 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 memberships service

  • Accepts multiple groups or subjects or memberhipIds (or combination) to retrieve lists of memberships
  • Documentation: SOAP (click on getMemberships), REST (click on getMemberships)
  • REST request (colon is escaped to %3A):
    • POST /grouper-ws/servicesRest/v1_6_000/groups/aStem%3AaGroup/memberships
    • POST /grouper-ws/servicesRest/v1_6_000/subjects/12345/memberships
    • POST /grouper-ws/servicesRest/v1_6_000/memberships
  • (see documentation above for details): Request object, response object
  • Response codes overall
  • Returns an overall status
  • Samples (all files without "Lite" in them, click on "download" to see files)
  • No labels