Child pages
  • Member change subject
Skip to end of metadata
Go to start of metadata

Grouper Web Services


"Member change subject" will change the subject that a member refers to. You would want to do this when a person or entity changes their id, or if they were loaded wrong in the system. If the new subject does not have a member associated with it, this is a simple case, where the subject data is put in the member object. If the new subject does have a member object, then all data in all tables that referred to the old member object, will now refer to the new member object. The old member is deleted from the member table by default, though this is an option. Generally you will want it removed, unless there is a foreign key problem where you need to do as much work as possible. In GSH you can get a dry-run report of what will be done.

The operation is potentially time consuming only when two formerly separate Subjects are being merged into one, and that the time required is to replace the memberships (and audit fields e.g. modifiedBy) of the formerly separate Subject that is being retired with new ones associated with the other Subject.


  • Will not fail if the new subject is the same as the old subject
  • Lookup subjects/members by subject lookup (by id, source, identifier, etc)
  • Returns subject information of the new subject
  • Can actAs another user

Member change subject Lite service

  • Accepts one subject (new) and one member (old) to change the subject information
  • Documentation: SOAP (click on memberChangeSubjectLite), REST (click on memberChangeSubjectLite)
  • For REST, a request body is required (probably via POST)
  • REST request (colon is escaped to %3A): PUT /grouper-ws/servicesRest/v1_4_000/members/10021368
  • (see documentation above for details): Request object, response object
  • Response codes
  • Samples (all files with "Lite" in them, click on "download" to see file)

Member change subject service

  • Accepts a list of subjects to change, and subjects to change to (and if the old should be deleted), to change the subjects of members
  • Can operate in one transaction, or can let each change occur in its own separate unit
  • Documentation: SOAP (click on memberChangeSubject), REST (click on memberChangeSubject)
  • REST request (colon is escaped to %3A): PUT /grouper-ws/servicesRest/v1_4_000/members
  • (see documentation above for details): Request object, response object
  • Response codes overall, response codes for each assignment
  • Returns an overall status, and a status for each change
  • Samples (all files without "Lite" in them, click on "download" to see files)
  • No labels