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.
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)