...
- There is a bug we are tracking with Axis, where if you skip String params, it will mix up the params. So, if you are passing a param to a web service, make sure you pass empty strings for all null params before the param
- Code clients with a mindset that the service might change in subtle ways. e.g. a result code might be added (check for success flag element, not success result code), an element might be added in a result object, another input element might be added to end of list, etc. Expect elements to be added in data. Note if you send the same version in the request, you will never get a response with a different structure. Grouper WS are backwards compatible.
- Make sure there is a property in the client of the URL and version for the service. The version of the service might change the URL (up to service deployer)...
- Note that Grouper WS can be setup with multiple instances. If you have database replication (even readonly), then you can setup Grouper WS application servers is multiple data centers, and you can have the Grouper Client can failover among the nodes if there are errors or timeouts.
Operations
- addMember: assign a member to a group
- If already a member, that is ok
- Accepts batches of members (non-Lite)
- Accepts flag to say that any members not in batch should be removed (e.g. replace list)
- deleteMember: unassign a member from a group
- If not a member, that is ok
- Accepts batches of members (non-Lite)
- Get Members: return the members (including subject data) in a group (from direct or indirect membership)
- Will accept member filter (All, Effective, Immediate, Composite)
- Accepts batches of groups (non-Lite)
- getMemberships
- Will accept member filter (All, Effective, Immediate, Composite)
- Accepts batches of subjects and groups (non-Lite)
- hasMember: see if a subject is a member of a group
- Will return true or false
- Accepts batches of subject ids or identifers (returns batches of true's / false's) (non-Lite)
- Will accept member filter (All, Effective, etc)
- Can query on field (permission)
- getGroups: list groups for a subject
- Will accept member filter (All, Effective, etc)
- Accepts batches of subjects (non-Lite)
- groupSave
- Create / update a group
- Accepts batches of groups (non-Lite)
- groupDelete
- Delete a group
- Accepts batches of groups (non-Lite)
- getGrouperPrivileges
- View privileges (many combinations of input are acceptable)
- Can view all privileges for the subject, group, stem, specific privilege and combinations thereof
- assignGrouperPrivileges
- Add or remove a privilege for a subject and (group or stem)
- Will not fail if the privilege is already assigned or revoked
- findGroups
- Can query for groups based on name, uuid, parent stem, or a substring query
- Can create complex queries with group match (AND, OR, MINUS) (non-Lite)
- findStems
- Can query for stems based on name, uuid, parent stem, or a substring query
- Can create complex queries with group match (AND, OR, MINUS) (non-Lite)
- findAttributeDefNames
- Can query for attributeDefNames/permissionNames based on name, uuid, inheritance, or a substring query
- Can sort/page
- stemSave
- Create / update a stem
- Accepts batches of stems (non-Lite)
- stemDelete
- Delete a stem
- Accepts batches (non-Lite)
- memberChangeSubject
- Change the subject of a current member
- Accepts batches (non-Lite)
- assignAttributes
- Assign or remove attributes (new attribute framework) from groups, stems, memberships, members, assignments, etc
- Accepts batches (non-Lite)
- getAttributeAssignments
- Retrieves attribute assignments (new attribute framework) from groups, stems, memberships, members, assignments, etc
- Batch or Lite
- assignPermissions
- Assign or remove permissions from roles or individual subjects (in the context of a role)
- Batch or Lite
- getPermissionAssignments
- Retrieves permission assignments from roles or individual subjects (in the context of a role)
- Batch or Lite
- Get Subjects
- Lookup or search for subjects and attributes
- Batch or Lite
- attributeDefNameSave
- Create / update an attributeDefName
- Accepts batches of attributeDefNames (non-Lite)
- attributeDefNameDelete
- Delete an attributeDefName
- Accepts batches of attributeDefNames lookups (non-Lite)
...