Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Include Page
spaceKeyGrouper
pageTitleNavigation

Grouper Web Services

Description

Assign attribute definition name inheritance based on lookups by name or ID. This is new as of Grouper v2.1.  Note: attribute definition name inheritance is only used for permissions (e.g. if the permission names are an org chart there would be inheritance)

Features

  • Pass in one parent attribute def name lookup by name or id
  • Pass in one or many child attribute def name lookup by name or id (note, only the non-lite service can pass more than one child lookup)
  • Pass in whether this an assignment or a removal of an assignment
  • Can replace the current child list with the inputted list (non-lite only)
  • Can pass in a txType so that you can run all the changes in one transaction, or just finish the work that is possible with no enclosing transaction
  • Returns if it was successful or not, and returns a string detailing how many inserts, deletes, and no-ops there were (if the inheritance or lack of already existed in that state)
  • Can actAs another user

assignAttributeDefNameInheritance Lite service

  • Accepts one attribute def name child to assign or unassign...
  • Documentation: SOAP (click on assignAttributeDefNameInheritanceLite), REST (click on assignAttributeDefNameInheritanceLite)
  • For REST, the request can put data in query string (in URL or request body)
  • REST request (colon is escaped to %3A): PUT /grouper-ws/servicesRest/v2_1_000/attributeDefNames
    • 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)

assignAttributeDefNameInheritance service

  • Accepts multiple attributeDefName children to assign or unassign
  • Documentation: SOAP (click on assignAttributeDefNameInheritance), REST (click on assignAttributeDefNameInheritance)
  • REST request (colon is escaped to %3A): POST /grouper-ws/servicesRest/v2_1_000/attributeDefNames
  • (see documentation above for details): Request object, response object
  • Response codes
  • Returns an overall status, and a status for each assignment
  • Samples (all files without "Lite" in them, click on "download" to see files)