Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Include Page
spaceKeyGrouper
pageTitleNavigation

Grouper Web Services

Description

"Add or remove grouper privileges" will add or remove privileges for a subject and (group or stem). If you are adding a privilege and it already exists (immediate privilege), then it will not fail, and it will notify you in the response (still considered a success). If you are removing a privilege, and there was no immediate privileges to remove, it will be a success, and will notify you by response code. If you remove a privilege, and there is an "effective" privilege still there (which means the subject has the privilege, just not directly), it will be a success, and you will be notified via response code.

Features

  • Will only edit the privileges the web service user (or actAs) is allowed to see
  • Lookup subjects/members by subject lookup (by id, source, identifier, etc)
  • Lookup groups/stems by group lookup or stem lookup (name or uuid)
  • Returns subject information of the subject
  • Returns the group or stem information
  • Can actAs another user
  • Failsafe, will not fail if adding a privilege that is already there, or removing one that is already gone
  • Descriptive response codes give information about the existing privileges
  • If replaceAllExisting is T, then allowed must be set to T.  This will assign the provided privilege(s) to the provided subject(s), and remove it from all other subjects who are assigned. If F or blank, assign or remove  (depending on value provided in 'allowed') the provided privilege(s) from the provided subject(s)

Assign grouper privileges Lite service

  • Accepts one subject, one privilege type and name, if allowed, and one group or stem lookup
  • Documentation: SOAP (click on assignGrouperPrivileges), REST (click on assignGrouperPrivileges)
  • For REST, a request body is required (probably via POST)
  • REST request (colon is escaped to %3A): PUT (or POST) /grouper-ws/servicesRest/v1_4_000/grouperPrivileges
  • (see documentation above for details): Request object, response object
  • Response codes
  • Samples (all files with "Lite" in them, click on "download" to see file)