Class GrouperService
java.lang.Object
edu.internet2.middleware.grouper.ws.soap.GrouperService
All public methods in this class are available in the web service as both SOAP and REST. This is the class that Axis uses to generate the WSDL. Also this is the class that request/response objects are generated from for REST (each param is a field in the object, each method is an object). Each method in this class has an outer try/catch that does error handling, it decodes enums and looks things up, then delegates to GrouperServiceLogic for the real business logic. In that class the Lite methods delegate to the real methods booleans can either be T, F, true, false (case-insensitive) get wsdl from: http://localhost:8090/grouper/services/GrouperService?wsdl generate client (after wsdl copied): C:\mchyzer\isc\dev\grouper\axisJar2>wsdl2java -p edu.internet2.middleware.grouper.webservicesClient -t -uri GrouperService.wsdl
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddMember
(String clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, String replaceAllExisting, WsSubjectLookup actAsSubjectLookup, String fieldName, String txType, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String disabledTime, String enabledTime) add member to a group (if already a direct member, ignore)addMemberLite
(String clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String disabledTime, String enabledTime) add member to a group (if already a direct member, ignore)assignAttributes
(String clientVersion, String attributeAssignType, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, String attributeAssignOperation, WsAttributeAssignValue[] values, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, String attributeAssignValueOperation, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsGroupLookup[] wsOwnerGroupLookups, WsStemLookup[] wsOwnerStemLookups, WsSubjectLookup[] wsOwnerSubjectLookups, WsMembershipLookup[] wsOwnerMembershipLookups, WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, WsAttributeAssignLookup[] wsOwnerAttributeAssignLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, WsAttributeDefLookup[] attributeDefsToReplace, String[] actionsToReplace, String[] attributeDefTypesToReplace) assign attributes and values to owner objects (groups, stems, etc)assignAttributesLite
(String clientVersion, String attributeAssignType, String wsAttributeDefNameName, String wsAttributeDefNameId, String attributeAssignOperation, String valueId, String valueSystem, String valueFormatted, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, String attributeAssignValueOperation, String wsAttributeAssignId, String wsOwnerGroupName, String wsOwnerGroupId, String wsOwnerStemName, String wsOwnerStemId, String wsOwnerSubjectId, String wsOwnerSubjectSourceId, String wsOwnerSubjectIdentifier, String wsOwnerMembershipId, String wsOwnerMembershipAnyGroupName, String wsOwnerMembershipAnyGroupId, String wsOwnerMembershipAnySubjectId, String wsOwnerMembershipAnySubjectSourceId, String wsOwnerMembershipAnySubjectIdentifier, String wsOwnerAttributeDefName, String wsOwnerAttributeDefId, String wsOwnerAttributeAssignId, String action, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) assign attributes and values to owner objects (groups, stems, etc)assignGrouperPrivileges
(String clientVersion, WsSubjectLookup[] wsSubjectLookups, WsGroupLookup wsGroupLookup, WsStemLookup wsStemLookup, String privilegeType, String[] privilegeNames, String allowed, String replaceAllExisting, String txType, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params) assign a privilege for a user/group/type/name combo e.g.assignGrouperPrivilegesLite
(String clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String groupName, String groupUuid, String stemName, String stemUuid, String privilegeType, String privilegeName, String allowed, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) add a privilge to a stem or group (ok if already existed) PUT e.g.assignPermissions
(String clientVersion, String permissionType, WsAttributeDefNameLookup[] permissionDefNameLookups, String permissionAssignOperation, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsGroupLookup[] roleLookups, WsMembershipAnyLookup[] subjectRoleLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, WsAttributeDefLookup[] attributeDefsToReplace, String[] actionsToReplace) assign permissions to roles or subjects (in the context of a role)assignPermissionsLite
(String clientVersion, String permissionType, String permissionDefNameName, String permissionDefNameId, String permissionAssignOperation, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, String wsAttributeAssignId, String roleName, String roleId, String subjectRoleName, String subjectRoleId, String subjectRoleSubjectId, String subjectRoleSubjectSourceId, String subjectRoleSubjectIdentifier, String action, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) assign permissions to role or subject (in the context of a role)deleteMember
(String clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, WsSubjectLookup actAsSubjectLookup, String fieldName, String txType, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params) remove member(s) from a group (if not already a direct member, ignore)deleteMemberLite
(String clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1) delete member to a group (if not already a direct member, ignore)findGroups
(String clientVersion, WsQueryFilter wsQueryFilter, WsSubjectLookup actAsSubjectLookup, String includeGroupDetail, WsParam[] params, WsGroupLookup[] wsGroupLookups) find a group or groupsfindGroupsLite
(String clientVersion, String queryFilterType, String groupName, String stemName, String stemNameScope, String groupUuid, String groupAttributeName, String groupAttributeValue, String groupTypeName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) find a group or groupsfindStems
(String clientVersion, WsStemQueryFilter wsStemQueryFilter, WsSubjectLookup actAsSubjectLookup, WsParam[] params, WsStemLookup[] wsStemLookups) find a stem or stemsfindStemsLite
(String clientVersion, String stemQueryFilterType, String stemName, String parentStemName, String parentStemNameScope, String stemUuid, String stemAttributeName, String stemAttributeValue, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) find a stem or stemsgetAttributeAssignments
(String clientVersion, String attributeAssignType, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsAttributeDefLookup[] wsAttributeDefLookups, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsGroupLookup[] wsOwnerGroupLookups, WsStemLookup[] wsOwnerStemLookups, WsSubjectLookup[] wsOwnerSubjectLookups, WsMembershipLookup[] wsOwnerMembershipLookups, WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, String[] actions, String includeAssignmentsOnAssignments, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, String enabled) get attributeAssignments from groups etc based on inputsgetAttributeAssignmentsLite
(String clientVersion, String attributeAssignType, String attributeAssignId, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String wsOwnerGroupName, String wsOwnerGroupId, String wsOwnerStemName, String wsOwnerStemId, String wsOwnerSubjectId, String wsOwnerSubjectSourceId, String wsOwnerSubjectIdentifier, String wsOwnerMembershipId, String wsOwnerMembershipAnyGroupName, String wsOwnerMembershipAnyGroupId, String wsOwnerMembershipAnySubjectId, String wsOwnerMembershipAnySubjectSourceId, String wsOwnerMembershipAnySubjectIdentifier, String wsOwnerAttributeDefName, String wsOwnerAttributeDefId, String action, String includeAssignmentsOnAssignments, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String enabled) get attributeAssignments based on inputsgetGrouperPrivilegesLite
(String clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String groupName, String groupUuid, String stemName, String stemUuid, String privilegeType, String privilegeName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) see if a group has a member (if already a direct member, ignore) GET e.g.getGroups
(String clientVersion, WsSubjectLookup[] subjectLookups, String memberFilter, WsSubjectLookup actAsSubjectLookup, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String fieldName, String scope, WsStemLookup wsStemLookup, String stemScope, String enabled, String pageSize, String pageNumber, String sortString, String ascending) get groups from members based on filter (accepts batch of members)getGroupsLite
(String clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String fieldName, String scope, String stemName, String stemUuid, String stemScope, String enabled, String pageSize, String pageNumber, String sortString, String ascending) get groups for a subject based on filtergetMembers
(String clientVersion, WsGroupLookup[] wsGroupLookups, String memberFilter, WsSubjectLookup actAsSubjectLookup, String fieldName, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String[] sourceIds) get members from a group based on a filter (all, immediate only, effective only, composite)getMemberships
(String clientVersion, WsGroupLookup[] wsGroupLookups, WsSubjectLookup[] wsSubjectLookups, String wsMemberFilter, WsSubjectLookup actAsSubjectLookup, String fieldName, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, String[] sourceIds, String scope, WsStemLookup wsStemLookup, String stemScope, String enabled, String[] membershipIds) get memberships from groups and or subjects based on a filter (all, immediate only, effective only, composite, nonimmediate).getMembershipsLite
(String clientVersion, String groupName, String groupUuid, String subjectId, String sourceId, String subjectIdentifier, String wsMemberFilter, String includeSubjectDetail, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String sourceIds, String scope, String stemName, String stemUuid, String stemScope, String enabled, String membershipIds) get memberships from a group based on a filter (all, immediate only, effective only, composite)getMembersLite
(String clientVersion, String groupName, String groupUuid, String memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String sourceIds) get members from a group based on a filter (all, immediate only, effective only, composite)getPermissionAssignments
(String clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsGroupLookup[] roleLookups, WsSubjectLookup[] wsSubjectLookups, String[] actions, String includePermissionAssignDetail, String includeAttributeDefNames, String includeAttributeAssignments, String includeAssignmentsOnAssignments, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, String enabled) get permissionAssignments from roles etc based on inputsgetPermissionAssignmentsLite
(String clientVersion, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String roleName, String roleId, String wsSubjectId, String wsSubjectSourceId, String wsSubjectIdentifier, String action, String includePermissionAssignDetail, String includeAttributeDefNames, String includeAttributeAssignments, String includeAssignmentsOnAssignments, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String enabled) get permissionAssignments from role etc based on inputsgetSubjects
(String clientVersion, WsSubjectLookup[] wsSubjectLookups, String searchString, String includeSubjectDetail, String[] subjectAttributeNames, WsSubjectLookup actAsSubjectLookup, String[] sourceIds, WsGroupLookup wsGroupLookup, String wsMemberFilter, String fieldName, String includeGroupDetail, WsParam[] params) get subjects from searching by id or identifier or search string.getSubjectsLite
(String clientVersion, String subjectId, String sourceId, String subjectIdentifier, String searchString, String includeSubjectDetail, String subjectAttributeNames, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String sourceIds, String groupName, String groupUuid, String wsMemberFilter, String fieldName, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) get subjects from searching by id or identifier or search string.groupDelete
(String clientVersion, WsGroupLookup[] wsGroupLookups, WsSubjectLookup actAsSubjectLookup, String txType, String includeGroupDetail, WsParam[] params) delete a group or many (if doesnt exist, ignore)groupDeleteLite
(String clientVersion, String groupName, String groupUuid, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) delete a group or many (if doesnt exist, ignore)groupSave
(String clientVersion, WsGroupToSave[] wsGroupToSaves, WsSubjectLookup actAsSubjectLookup, String txType, String includeGroupDetail, WsParam[] params) save a group or many (insert or update).groupSaveLite
(String clientVersion, String groupLookupUuid, String groupLookupName, String groupUuid, String groupName, String displayExtension, String description, String saveMode, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) save a stem (insert or update).hasMember
(String clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, String memberFilter, WsSubjectLookup actAsSubjectLookup, String fieldName, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params) see if a group has members based on filter (accepts batch of members)hasMemberLite
(String clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1) see if a group has a member (if already a direct member, ignore)memberChangeSubject
(String clientVersion, WsMemberChangeSubject[] wsMemberChangeSubjects, WsSubjectLookup actAsSubjectLookup, String txType, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params) add member to a group (if already a direct member, ignore)memberChangeSubjectLite
(String clientVersion, String oldSubjectId, String oldSubjectSourceId, String oldSubjectIdentifier, String newSubjectId, String newSubjectSourceId, String newSubjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String deleteOldMember, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1) see if a group has a member (if already a direct member, ignore)stemDelete
(String clientVersion, WsStemLookup[] wsStemLookups, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) delete a stem or many (if doesnt exist, ignore)stemDeleteLite
(String clientVersion, String stemName, String stemUuid, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) delete a stem or many (if doesnt exist, ignore)stemSave
(String clientVersion, WsStemToSave[] wsStemToSaves, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) save a stem or many (insert or update).stemSaveLite
(String clientVersion, String stemLookupUuid, String stemLookupName, String stemUuid, String stemName, String displayExtension, String description, String saveMode, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) save a stem (insert or update).
-
Constructor Details
-
GrouperService
public GrouperService()default
-
-
Method Details
-
findGroupsLite
public WsFindGroupsResults findGroupsLite(String clientVersion, String queryFilterType, String groupName, String stemName, String stemNameScope, String groupUuid, String groupAttributeName, String groupAttributeValue, String groupTypeName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) find a group or groups- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000queryFilterType
- findGroupType is the WsQueryFilterType enum for which type of find is happening: e.g. FIND_BY_GROUP_UUID, FIND_BY_GROUP_NAME_EXACT, FIND_BY_STEM_NAME, FIND_BY_APPROXIMATE_ATTRIBUTE, FIND_BY_GROUP_NAME_APPROXIMATE, FIND_BY_TYPE, AND, OR, MINUS;groupName
- search by group name (must match exactly), cannot use other params with thisstemName
- will return groups in this stem. can be used with various query typesstemNameScope
- if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree. Required if searching by stemgroupUuid
- search by group uuid (must match exactly), cannot use other params with thisgroupAttributeName
- if searching by attribute, this is name, or null for all attributesgroupAttributeValue
- if searching by attribute, this is the valuegroupTypeName
- if searching by type, this is the type. not yet implementedactAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- optional to narrow the act as subject search to a particular sourceincludeGroupDetail
- T or F as for if group detail should be includedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the groups, or no groups if none found
-
findStems
public WsFindStemsResults findStems(String clientVersion, WsStemQueryFilter wsStemQueryFilter, WsSubjectLookup actAsSubjectLookup, WsParam[] params, WsStemLookup[] wsStemLookups) find a stem or stems- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsStemQueryFilter
- is the filter properties that can search by name, uuid, approximate attribute, and can do group math on multiple operations, etcincludeStemDetail
- T or F as to if the stem detail should be included (defaults to F)actAsSubjectLookup
-params
- optional: reserved for future usewsStemLookups
- to pass in a list of uuids or names to lookup. Note the stems are returned in alphabetical order- Returns:
- the stems, or no stems if none found
-
findGroups
public WsFindGroupsResults findGroups(String clientVersion, WsQueryFilter wsQueryFilter, WsSubjectLookup actAsSubjectLookup, String includeGroupDetail, WsParam[] params, WsGroupLookup[] wsGroupLookups) find a group or groups- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsQueryFilter
- is the filter properties that can search by name, uuid, attribute, type, and can do group math on multiple operations, etcincludeGroupDetail
- T or F as to if the group detail should be included (defaults to F)actAsSubjectLookup
-params
- optional: reserved for future usewsGroupLookups
- if you want to just pass in a list of uuids and/or names. Note the stems are returned in alphabetical order- Returns:
- the groups, or no groups if none found
-
getMembersLite
public WsGetMembersLiteResult getMembersLite(String clientVersion, String groupName, String groupUuid, String memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String sourceIds) get members from a group based on a filter (all, immediate only, effective only, composite)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000groupName
- to lookup the group (mutually exclusive with groupUuid)groupUuid
- to lookup the group (mutually exclusive with groupName)memberFilter
- must be one of All, Effective, Immediate, CompositeincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is the source to use to lookup the subject (if applicable)actAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferfieldName
- is if the member should be added to a certain field membership of the group (certain list)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent. Comma-separate if multipleincludeGroupDetail
- T or F as to if the group detail should be returnedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future usesourceIds
- comma separated source ids or null for all- Returns:
- the members, or no members if none found
-
getMembers
public WsGetMembersResults getMembers(String clientVersion, WsGroupLookup[] wsGroupLookups, String memberFilter, WsSubjectLookup actAsSubjectLookup, String fieldName, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String[] sourceIds) get members from a group based on a filter (all, immediate only, effective only, composite)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsGroupLookups
- are groups to querymemberFilter
- must be one of All, Effective, Immediate, CompositeincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectLookup
-fieldName
- is if the member should be added to a certain field membership of the group (certain list)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparams
- optional: reserved for future usesourceIds
- array of source ids or null if all- Returns:
- the results
-
getGroups
public WsGetGroupsResults getGroups(String clientVersion, WsSubjectLookup[] subjectLookups, String memberFilter, WsSubjectLookup actAsSubjectLookup, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String fieldName, String scope, WsStemLookup wsStemLookup, String stemScope, String enabled, String pageSize, String pageNumber, String sortString, String ascending) get groups from members based on filter (accepts batch of members)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000subjectLookups
- subjects to be examined to get groupsmemberFilter
- can be All, Effective (non immediate), Immediate (direct), Composite (if composite group with group math (union, minus, etc)actAsSubjectLookup
- to act as a different user than the logged in userincludeGroupDetail
- T or F as to if the group detail should be included (defaults to F)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)params
- optional: reserved for future usefieldName
- is field name (list name) to search or blank for default listscope
- is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:wsStemLookup
- is the stem to check in, or null if all. If has stem, must have stemScopestemScope
- is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stemenabled
- is A for all, T or null for enabled only, F for disabledpageSize
- page size if pagingpageNumber
- page number 1 indexed if pagingsortString
- must be an hql query field, e.g. can sort on name, displayName, extension, displayExtensionascending
- or null for ascending, F for descending. If you pass T or F, must pass a sort string- Returns:
- the results
-
hasMember
public WsHasMemberResults hasMember(String clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, String memberFilter, WsSubjectLookup actAsSubjectLookup, String fieldName, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params) see if a group has members based on filter (accepts batch of members)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsGroupLookup
- for the group to see if the members are in theresubjectLookups
- subjects to be examined to see if in groupmemberFilter
- can be All, Effective (non immediate), Immediate (direct), Composite (if composite group with group math (union, minus, etc)actAsSubjectLookup
- to act as a different user than the logged in userfieldName
- is if the Group.hasMember() method with field is to be called (e.g. admins, optouts, optins, etc from Field table in DB)txType
- is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.includeGroupDetail
- T or F as to if the group detail should be returnedincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentparams
- optional: reserved for future use- Returns:
- the results
-
stemDeleteLite
public WsStemDeleteLiteResult stemDeleteLite(String clientVersion, String stemName, String stemUuid, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) delete a stem or many (if doesnt exist, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000stemName
- to delete the stem (mutually exclusive with stemUuid)stemUuid
- to delete the stem (mutually exclusive with stemName)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the result of one member add
-
groupDeleteLite
public WsGroupDeleteLiteResult groupDeleteLite(String clientVersion, String groupName, String groupUuid, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) delete a group or many (if doesnt exist, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000groupName
- to delete the group (mutually exclusive with groupUuid)groupUuid
- to delete the group (mutually exclusive with groupName)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferincludeGroupDetail
- T or F as to if the group detail should be returnedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the result of one member add
-
groupSaveLite
public WsGroupSaveLiteResult groupSaveLite(String clientVersion, String groupLookupUuid, String groupLookupName, String groupUuid, String groupName, String displayExtension, String description, String saveMode, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) save a stem (insert or update). Note you cannot currently move an existing group.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000groupLookupUuid
- the uuid of the group to edit (mutually exclusive with groupLookupName)groupLookupName
- the name of the group to edit (mutually exclusive with groupLookupUuid)groupName
- to delete the group (mutually exclusive with groupUuid)groupUuid
- to delete the group (mutually exclusive with groupName)description
- of the group, empty will be ignoreddisplayExtension
- display name of the group, empty will be ignoredsaveMode
- if the save should be constrained to INSERT, UPDATE, or INSERT_OR_UPDATE (default)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferincludeGroupDetail
- T or F as to if the group detail should be returnedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the result of one member add
-
stemSaveLite
public WsStemSaveLiteResult stemSaveLite(String clientVersion, String stemLookupUuid, String stemLookupName, String stemUuid, String stemName, String displayExtension, String description, String saveMode, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) save a stem (insert or update). Note you cannot move an existing stem.- Parameters:
stemLookupUuid
- the uuid of the stem to save (mutually exclusive with stemLookupName), null for insertstemLookupName
- the name of the stam to save (mutually exclusive with stemLookupUuid), null for insertclientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000stemName
- data of stem to savestemUuid
- uuid data of stem to savedescription
- of the stemdisplayExtension
- of the stemsaveMode
- if the save should be constrained to INSERT, UPDATE, or INSERT_OR_UPDATE (default)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the result of one member add
-
groupSave
public WsGroupSaveResults groupSave(String clientVersion, WsGroupToSave[] wsGroupToSaves, WsSubjectLookup actAsSubjectLookup, String txType, String includeGroupDetail, WsParam[] params) save a group or many (insert or update). Note, you cannot rename an existing group.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsGroupToSaves
- groups to saveactAsSubjectLookup
-txType
- is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.includeGroupDetail
- T or F as to if the group detail should be returnedparams
- optional: reserved for future use- Returns:
- the results
-
stemSave
public WsStemSaveResults stemSave(String clientVersion, WsStemToSave[] wsStemToSaves, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) save a stem or many (insert or update). Note, you cannot move an existing stem.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsStemToSaves
- stems to saveactAsSubjectLookup
-txType
- is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.params
- optional: reserved for future use- Returns:
- the results
-
stemDelete
public WsStemDeleteResults stemDelete(String clientVersion, WsStemLookup[] wsStemLookups, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) delete a stem or many (if doesnt exist, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000stemName
- name of stem to delete (mutually exclusive with uuid)stemUuid
- uuid of stem to delete (mutually exclusive with name)wsStemLookups
- stem lookups of stems to delete (specify name or uuid)actAsSubjectLookup
-txType
- is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.params
- optional: reserved for future use- Returns:
- the results
-
groupDelete
public WsGroupDeleteResults groupDelete(String clientVersion, WsGroupLookup[] wsGroupLookups, WsSubjectLookup actAsSubjectLookup, String txType, String includeGroupDetail, WsParam[] params) delete a group or many (if doesnt exist, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsGroupLookups
- groups to deleteactAsSubjectLookup
-txType
- is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.includeGroupDetail
- T or F as to if the group detail should be returnedparams
- optional: reserved for future use- Returns:
- the results
-
addMember
public WsAddMemberResults addMember(String clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, String replaceAllExisting, WsSubjectLookup actAsSubjectLookup, String fieldName, String txType, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String disabledTime, String enabledTime) add member to a group (if already a direct member, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsGroupLookup
- group to add the members tosubjectLookups
- subjects to be added to the groupreplaceAllExisting
- optional: T or F (default), if the existing groups should be replacedactAsSubjectLookup
-fieldName
- is if the member should be added to a certain field membership of the group (certain list)txType
- is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.includeGroupDetail
- T or F as to if the group detail should be returnedsubjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)params
- optional: reserved for future usedisabledTime
- date this membership will be disabled, yyyy/MM/dd HH:mm:ss.SSSenabledTime
- date this membership will be enabled (for future provisioning), yyyy/MM/dd HH:mm:ss.SSS- Returns:
- the results
- See Also:
-
deleteMember
public WsDeleteMemberResults deleteMember(String clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, WsSubjectLookup actAsSubjectLookup, String fieldName, String txType, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params) remove member(s) from a group (if not already a direct member, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsGroupLookup
-subjectLookups
- subjects to be deleted to the groupactAsSubjectLookup
-fieldName
- is if the member should be added to a certain field membership of the group (certain list)txType
- is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.includeGroupDetail
- T or F as to if the group detail should be returnedsubjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)params
- optional: reserved for future use- Returns:
- the results
-
getGroupsLite
public WsGetGroupsLiteResult getGroupsLite(String clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String fieldName, String scope, String stemName, String stemUuid, String stemScope, String enabled, String pageSize, String pageNumber, String sortString, String ascending) get groups for a subject based on filter- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000subjectId
- to add (mutually exclusive with subjectIdentifier)subjectSourceId
- is source of subject to narrow the result and prevent duplicatessubjectIdentifier
- to add (mutually exclusive with subjectId)includeGroupDetail
- T or F as to if the group detail should be included (defaults to F)memberFilter
- can be All, Effective (non immediate), Immediate (direct), Composite (if composite group with group math (union, minus, etc)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)paramName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future usefieldName
- is field name (list name) to search or blank for default listscope
- is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:stemName
- is the stem to check in, or null if all. If has stem, must have stemScopestemUuid
- is the stem to check in, or null if all. If has stem, must have stemScopestemScope
- is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stemenabled
- is A for all, T or blank for enabled only, F for disabledpageSize
- page size if pagingpageNumber
- page number 1 indexed if pagingsortString
- must be an hql query field, e.g. can sort on name, displayName, extension, displayExtensionascending
- or null for ascending, false for descending. If you pass true or false, must pass a sort string- Returns:
- the result of one member add
-
addMemberLite
public WsAddMemberLiteResult addMemberLite(String clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String disabledTime, String enabledTime) add member to a group (if already a direct member, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000groupName
- to lookup the group (mutually exclusive with groupUuid)groupUuid
- to lookup the group (mutually exclusive with groupName)subjectId
- to add (mutually exclusive with subjectIdentifier)subjectSourceId
- is source of subject to narrow the result and prevent duplicatessubjectIdentifier
- to add (mutually exclusive with subjectId)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferfieldName
- is if the member should be added to a certain field membership of the group (certain list)includeGroupDetail
- T or F as to if the group detail should be returnedincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent. Comma-separate if multipleparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future usedisabledTime
- date this membership will be disabled: yyyy/MM/dd HH:mm:ss.SSSenabledTime
- date this membership will be enabled (for future provisioning): yyyy/MM/dd HH:mm:ss.SSS- Returns:
- the result of one member add
-
hasMemberLite
public WsHasMemberLiteResult hasMemberLite(String clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1) see if a group has a member (if already a direct member, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000groupName
- to lookup the group (mutually exclusive with groupUuid)groupUuid
- to lookup the group (mutually exclusive with groupName)subjectId
- to query (mutually exclusive with subjectIdentifier)subjectSourceId
- is source of subject to narrow the result and prevent duplicatessubjectIdentifier
- to query (mutually exclusive with subjectId)includeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)memberFilter
- can be All, Effective (non immediate), Immediate (direct), Composite (if composite group with group math (union, minus, etc)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferfieldName
- is if the Group.hasMember() method with field is to be called (e.g. admins, optouts, optins, etc from Field table in DB)includeGroupDetail
- T or F as to if the group detail should be returnedincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the result of one member query
-
memberChangeSubjectLite
public WsMemberChangeSubjectLiteResult memberChangeSubjectLite(String clientVersion, String oldSubjectId, String oldSubjectSourceId, String oldSubjectIdentifier, String newSubjectId, String newSubjectSourceId, String newSubjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String deleteOldMember, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1) see if a group has a member (if already a direct member, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000oldSubjectId
- subject id of old member object. This is the preferred way to look up the old subject, but subjectIdentifier could also be usedoldSubjectSourceId
- source id of old member object (optional)oldSubjectIdentifier
- subject identifier of old member object. It is preferred to lookup the old subject by id, but if identifier is used, that is ok instead (as long as subject is resolvable).newSubjectId
- preferred way to identify the new subject idnewSubjectSourceId
- preferres way to identify the new subject idnewSubjectIdentifier
- subjectId is the preferred way to lookup the new subject, but identifier is ok to use insteadincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id) of the new subjectsubjectAttributeNames
- are the additional subject attributes (data) to return of the new subject If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferdeleteOldMember
- T or F as to whether the old member should be deleted (if new member does exist). This defaults to T if it is blanksubjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the result of one member query
-
memberChangeSubject
public WsMemberChangeSubjectResults memberChangeSubject(String clientVersion, WsMemberChangeSubject[] wsMemberChangeSubjects, WsSubjectLookup actAsSubjectLookup, String txType, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params) add member to a group (if already a direct member, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsMemberChangeSubjects
- list of objects which describe a member change subjectactAsSubjectLookup
-txType
- is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)params
- optional: reserved for future use- Returns:
- the results
- See Also:
-
deleteMemberLite
public WsDeleteMemberLiteResult deleteMemberLite(String clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1) delete member to a group (if not already a direct member, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000groupName
- to lookup the group (mutually exclusive with groupUuid)groupUuid
- to lookup the group (mutually exclusive with groupName)subjectId
- to lookup the subject (mutually exclusive with subjectIdentifier)subjectSourceId
- is source of subject to narrow the result and prevent duplicatessubjectIdentifier
- to lookup the subject (mutually exclusive with subjectId)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferfieldName
- is if the member should be added to a certain field membership of the group (certain list)includeGroupDetail
- T or F as to if the group detail should be returnedincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent. Comma-separate if multipleparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the result of one member delete
-
findStemsLite
public WsFindStemsResults findStemsLite(String clientVersion, String stemQueryFilterType, String stemName, String parentStemName, String parentStemNameScope, String stemUuid, String stemAttributeName, String stemAttributeValue, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) find a stem or stems- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000stemQueryFilterType
- findStemType is the WsFindStemType enum for which type of find is happening: e.g. FIND_BY_STEM_UUID, FIND_BY_STEM_NAME, FIND_BY_PARENT_STEM_NAME, FIND_BY_APPROXIMATE_ATTRIBUTE, FIND_BY_STEM_NAME_APPROXIMATE AND, OR, MINUS;stemName
- search by stem name (must match exactly), cannot use other params with thisparentStemName
- will return stems in this stem. can be used with various query typesparentStemNameScope
- if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree. Required if searching by stemstemUuid
- search by stem uuid (must match exactly), cannot use other params with thisstemAttributeName
- if searching by attribute, this is name, or null for all attributesstemAttributeValue
- if searching by attribute, this is the valueactAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- optional to narrow the act as subject search to a particular sourceparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the stems, or no stems if none found
-
getGrouperPrivilegesLite
public WsGetGrouperPrivilegesLiteResult getGrouperPrivilegesLite(String clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String groupName, String groupUuid, String stemName, String stemUuid, String privilegeType, String privilegeName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) see if a group has a member (if already a direct member, ignore) GET e.g. /grouperPrivileges/subjects/1234567/groups/aStem:aGroup e.g. /grouperPrivileges/subjects/sources/someSource/subjectId/1234567/stems/aStem1:aStem2/
- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000subjectId
- subject id of subject to search for privileges. Mutually exclusive with subjectIdentifiersubjectSourceId
- source id of subject object (optional)subjectIdentifier
- subject identifier of subject. Mutuallyexclusive with subjectIdgroupName
- if this is a group privilege. mutually exclusive with groupUuidgroupUuid
- if this is a group privilege. mutually exclusive with groupNamestemName
- if this is a stem privilege. mutually exclusive with stemUuidstemUuid
- if this is a stem privilege. mutually exclusive with stemNameactAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferprivilegeType
- (e.g. "access" for groups and "naming" for stems)privilegeName
- (e.g. for groups: read, view, update, admin, optin, optout. e.g. for stems: stem, create)includeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)includeGroupDetail
- T or F as for if group detail should be includedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the result of one member query
-
assignGrouperPrivilegesLite
public WsAssignGrouperPrivilegesLiteResult assignGrouperPrivilegesLite(String clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String groupName, String groupUuid, String stemName, String stemUuid, String privilegeType, String privilegeName, String allowed, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) add a privilge to a stem or group (ok if already existed) PUT e.g. /grouperPrivileges/subjects/1234567/groups/aStem:aGroup e.g. /grouperPrivileges/subjects/sources/someSource/subjectId/1234567/stems/aStem1:aStem2/
- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000subjectId
- subject id of subject to search for privileges. Mutually exclusive with subjectIdentifiersubjectSourceId
- source id of subject object (optional)subjectIdentifier
- subject identifier of subject. Mutuallyexclusive with subjectIdgroupName
- if this is a group privilege. mutually exclusive with groupUuidgroupUuid
- if this is a group privilege. mutually exclusive with groupNamestemName
- if this is a stem privilege. mutually exclusive with stemUuidstemUuid
- if this is a stem privilege. mutually exclusive with stemNameactAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferdeleteOldMember
- T or F as to whether the old member should be deleted (if new member does exist). This defaults to T if it is blankprivilegeType
- (e.g. "access" for groups and "naming" for stems)privilegeName
- (e.g. for groups: read, view, update, admin, optin, optout. e.g. for stems: stem, create)allowed
- T|F is this is allowing the privilege, or denying itincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)includeGroupDetail
- T or F as for if group detail should be includedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the result of one member query
-
getMemberships
public WsGetMembershipsResults getMemberships(String clientVersion, WsGroupLookup[] wsGroupLookups, WsSubjectLookup[] wsSubjectLookups, String wsMemberFilter, WsSubjectLookup actAsSubjectLookup, String fieldName, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, String[] sourceIds, String scope, WsStemLookup wsStemLookup, String stemScope, String enabled, String[] membershipIds) get memberships from groups and or subjects based on a filter (all, immediate only, effective only, composite, nonimmediate).- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsGroupLookups
- are groups to look inwsSubjectLookups
- are subjects to look inwsMemberFilter
- must be one of All, Effective, Immediate, Composite, NonImmediateincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectLookup
-fieldName
- is if the memberships should be retrieved from a certain field membership of the group (certain list) of the group (certain list)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparams
- optional: reserved for future usesourceIds
- are sources to look in for memberships, or null if allscope
- is a sql like string which will have a percent % concatenated to the end for group names to search in (or stem names)wsStemLookup
- is the stem to look in for membershipsstemScope
- is StemScope to search only in one stem or in substems: ONE_LEVEL, ALL_IN_SUBTREEenabled
- is A for all, T or null for enabled only, F for disabledmembershipIds
- are the ids to search for if they are known- Returns:
- the results
-
getMembershipsLite
public WsGetMembershipsResults getMembershipsLite(String clientVersion, String groupName, String groupUuid, String subjectId, String sourceId, String subjectIdentifier, String wsMemberFilter, String includeSubjectDetail, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String sourceIds, String scope, String stemName, String stemUuid, String stemScope, String enabled, String membershipIds) get memberships from a group based on a filter (all, immediate only, effective only, composite)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000groupName
- to lookup the group (mutually exclusive with groupUuid)groupUuid
- to lookup the group (mutually exclusive with groupName)subjectId
- to search for memberships in or null to not restrictsourceId
- of subject to search for memberships, or null to not restrictsubjectIdentifier
- of subject to search for memberships, or null to not restrictwsMemberFilter
- must be one of All, Effective, Immediate, CompositeincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferfieldName
- is if the member should be added to a certain field membership of the group (certain list)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent. Comma-separate if multipleincludeGroupDetail
- T or F as to if the group detail should be returnedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future usesourceIds
- are comma separated sourceIdsscope
- is a sql like string which will have a percent % concatenated to the end for group names to search in (or stem names)stemName
- to limit the search to a stem (in or under)stemUuid
- to limit the search to a stem (in or under)stemScope
- to specify if we are searching in or under the stemenabled
- A for all, null or T for enabled only, F for disabled onlymembershipIds
- comma separated list of membershipIds to retrieve- Returns:
- the memberships, or none if none found
-
getSubjects
public WsGetSubjectsResults getSubjects(String clientVersion, WsSubjectLookup[] wsSubjectLookups, String searchString, String includeSubjectDetail, String[] subjectAttributeNames, WsSubjectLookup actAsSubjectLookup, String[] sourceIds, WsGroupLookup wsGroupLookup, String wsMemberFilter, String fieldName, String includeGroupDetail, WsParam[] params) get subjects from searching by id or identifier or search string. Can filter by subjects which are members in a group.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsSubjectLookups
- are subjects to look insearchString
- free form string query to find a list of subjects (exact behavior depends on source)wsMemberFilter
- must be one of All, Effective, Immediate, Composite, NonImmediateincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectLookup
-fieldName
- is if the memberships should be retrieved from a certain field membership of the group (certain list) of the group (certain list)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparams
- optional: reserved for future usesourceIds
- are sources to look in for memberships, or null if allwsGroupLookup
- specify a group if the subjects must be in the group (limit of number of subjects found in list is much lower e.g. 1000)- Returns:
- the results
-
getSubjectsLite
public WsGetSubjectsResults getSubjectsLite(String clientVersion, String subjectId, String sourceId, String subjectIdentifier, String searchString, String includeSubjectDetail, String subjectAttributeNames, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String sourceIds, String groupName, String groupUuid, String wsMemberFilter, String fieldName, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) get subjects from searching by id or identifier or search string. Can filter by subjects which are members in a group.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsSubjectLookups
- are subjects to look insubjectId
- to find a subject by idsourceId
- to find a subject by id or identifiersubjectIdentifier
- to find a subject by identifiersearchString
- free form string query to find a list of subjects (exact behavior depends on source)wsMemberFilter
- must be one of All, Effective, Immediate, Composite, NonImmediate or null (all)includeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectId
- optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferactAsSubjectSourceId
- is source of act as subject to narrow the result and prevent duplicatesactAsSubjectIdentifier
- optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentiferfieldName
- is if the memberships should be retrieved from a certain field membership of the group (certain list)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent. Comma-separate if multipleincludeGroupDetail
- T or F as to if the group detail should be returnedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future usesourceIds
- are comma separated sourceIds for a searchStringgroupName
- specify a group if the subjects must be in the group (limit of number of subjects found in list is much lower e.g. 1000)groupUuid
- specify a group if the subjects must be in the group (limit of number of subjects found in list is much lower e.g. 1000)- Returns:
- the results or none if none found
-
assignGrouperPrivileges
public WsAssignGrouperPrivilegesResults assignGrouperPrivileges(String clientVersion, WsSubjectLookup[] wsSubjectLookups, WsGroupLookup wsGroupLookup, WsStemLookup wsStemLookup, String privilegeType, String[] privilegeNames, String allowed, String replaceAllExisting, String txType, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params) assign a privilege for a user/group/type/name combo e.g. POST /grouperPrivileges
- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsSubjectLookups
- are the subjects to assign the privileges to, looked up by subjectId or identifierwsGroupLookup
- if this is a group privilege, this is the groupwsStemLookup
- if this is a stem privilege, this is the stemreplaceAllExisting
- optional: T or F (default), if the existing privilege assignments for this object should be replacedactAsSubjectLookup
- optional: is the subject to act as (if proxying).privilegeType
- (e.g. "access" for groups and "naming" for stems)privilegeNames
- (e.g. for groups: read, view, update, admin, optin, optout. e.g. for stems: stem, create)allowed
- is T to allow this privilege, F to deny this privilegeincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)includeGroupDetail
- T or F as for if group detail should be includedtxType
- is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.params
- optional: reserved for future use- Returns:
- the result of one member query
-
getAttributeAssignments
public WsGetAttributeAssignmentsResults getAttributeAssignments(String clientVersion, String attributeAssignType, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsAttributeDefLookup[] wsAttributeDefLookups, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsGroupLookup[] wsOwnerGroupLookups, WsStemLookup[] wsOwnerStemLookups, WsSubjectLookup[] wsOwnerSubjectLookups, WsMembershipLookup[] wsOwnerMembershipLookups, WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, String[] actions, String includeAssignmentsOnAssignments, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, String enabled) get attributeAssignments from groups etc based on inputs- Parameters:
attributeAssignType
- Type of owner, from enum AttributeAssignType, e.g. group, member, stem, any_mem, imm_mem, attr_def, NOT: group_asgn, NOT: mem_asgn, NOT: stem_asgn, NOT: any_mem_asgn, NOT: imm_mem_asgn, NOT: attr_def_asgnclientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeAssignLookups
- if you know the assign ids you want, put them herewsOwnerGroupLookups
- are groups to look inwsOwnerSubjectLookups
- are subjects to look inwsAttributeDefLookups
- find assignments in these attribute defs (optional)wsAttributeDefNameLookups
- find assignments in these attribute def names (optional)wsOwnerStemLookups
- are stems to look inwsOwnerMembershipLookups
- to query attributes on immediate membershipswsOwnerMembershipAnyLookups
- to query attributes in "any" memberships which are on immediate or effective membershipswsOwnerAttributeDefLookups
- to query attributes assigned on attribute defsactions
- to query, or none to query all actionsincludeAssignmentsOnAssignments
- if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.includeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectLookup
-subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparams
- optional: reserved for future useenabled
- is A for all, T or null for enabled only, F for disabled- Returns:
- the results
-
getAttributeAssignmentsLite
public WsGetAttributeAssignmentsResults getAttributeAssignmentsLite(String clientVersion, String attributeAssignType, String attributeAssignId, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String wsOwnerGroupName, String wsOwnerGroupId, String wsOwnerStemName, String wsOwnerStemId, String wsOwnerSubjectId, String wsOwnerSubjectSourceId, String wsOwnerSubjectIdentifier, String wsOwnerMembershipId, String wsOwnerMembershipAnyGroupName, String wsOwnerMembershipAnyGroupId, String wsOwnerMembershipAnySubjectId, String wsOwnerMembershipAnySubjectSourceId, String wsOwnerMembershipAnySubjectIdentifier, String wsOwnerAttributeDefName, String wsOwnerAttributeDefId, String action, String includeAssignmentsOnAssignments, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String enabled) get attributeAssignments based on inputs- Parameters:
attributeAssignType
- Type of owner, from enum AttributeAssignType, e.g. group, member, stem, any_mem, imm_mem, attr_def, NOT: group_asgn, NOT: mem_asgn, NOT: stem_asgn, NOT: any_mem_asgn, NOT: imm_mem_asgn, NOT: attr_def_asgnclientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000attributeAssignId
- if you know the assign id you want, put it herewsAttributeDefName
- find assignments in this attribute def (optional)wsAttributeDefId
- find assignments in this attribute def (optional)wsAttributeDefNameName
- find assignments in this attribute def name (optional)wsAttributeDefNameId
- find assignments in this attribute def name (optional)wsOwnerGroupName
- is group name to look inwsOwnerGroupId
- is group id to look inwsOwnerStemName
- is stem to look inwsOwnerStemId
- is stem to look inwsOwnerSubjectId
- is subject to look inwsOwnerSubjectSourceId
- is subject to look inwsOwnerSubjectIdentifier
- is subject to look inwsOwnerMembershipId
- to query attributes on immediate membershipwsOwnerMembershipAnyGroupName
- to query attributes in "any" membership which is on immediate or effective membershipwsOwnerMembershipAnyGroupId
- to query attributes in "any" membership which is on immediate or effective membershipwsOwnerMembershipAnySubjectId
- to query attributes in "any" membership which is on immediate or effective membershipwsOwnerMembershipAnySubjectSourceId
- to query attributes in "any" membership which is on immediate or effective membershipwsOwnerMembershipAnySubjectIdentifier
- to query attributes in "any" membership which is on immediate or effective membershipwsOwnerAttributeDefName
- to query attributes assigned on attribute defwsOwnerAttributeDefId
- to query attributes assigned on attribute defaction
- to query, or none to query all actionsincludeAssignmentsOnAssignments
- if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.actAsSubjectId
-actAsSubjectSourceId
-actAsSubjectIdentifier
-includeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)subjectAttributeNames
- are the additional subject attributes (data) to return (comma separated) If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future useenabled
- is A for all, T or null for enabled only, F for disabled- Returns:
- the results
-
assignAttributes
public WsAssignAttributesResults assignAttributes(String clientVersion, String attributeAssignType, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, String attributeAssignOperation, WsAttributeAssignValue[] values, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, String attributeAssignValueOperation, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsGroupLookup[] wsOwnerGroupLookups, WsStemLookup[] wsOwnerStemLookups, WsSubjectLookup[] wsOwnerSubjectLookups, WsMembershipLookup[] wsOwnerMembershipLookups, WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, WsAttributeAssignLookup[] wsOwnerAttributeAssignLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, WsAttributeDefLookup[] attributeDefsToReplace, String[] actionsToReplace, String[] attributeDefTypesToReplace) assign attributes and values to owner objects (groups, stems, etc)- Parameters:
attributeAssignType
- Type of owner, from enum AttributeAssignType, e.g. group, member, stem, any_mem, imm_mem, attr_def, group_asgn, mem_asgn, stem_asgn, any_mem_asgn, imm_mem_asgn, attr_def_asgnclientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeAssignLookups
- if you know the assign ids you want, put them herewsOwnerGroupLookups
- are groups to look inwsOwnerSubjectLookups
- are subjects to look inwsAttributeDefNameLookups
- attribute def names to assign to the ownersattributeAssignOperation
- operation to perform for attribute on owners, from enum AttributeAssignOperation assign_attr, add_attr, remove_attrvalues
- are the values to assign, replace, remove, etc. If removing, and id is specified, will only remove values with that id.assignmentNotes
- notes on the assignment (optional)assignmentEnabledTime
- enabled time, or null for enabled nowassignmentDisabledTime
- disabled time, or null for not disableddelegatable
- really only for permissions, if the assignee can delegate to someone else. TRUE|FALSE|GRANTattributeAssignValueOperation
- operation to perform for attribute value on attribute assignments: assign_value, add_value, remove_value, replace_valueswsOwnerStemLookups
- are stems to look inwsOwnerMembershipLookups
- to query attributes on immediate membershipswsOwnerMembershipAnyLookups
- to query attributes in "any" memberships which are on immediate or effective membershipswsOwnerAttributeDefLookups
- to query attributes assigned on attribute defswsOwnerAttributeAssignLookups
- for assignment on assignmentactions
- to assign, or "assign" is the default if blankincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectLookup
-wsAttributeAssignLookups
- lookups to remove etcsubjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparams
- optional: reserved for future useattributeDefsToReplace
- if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do allactionsToReplace
- if replacing attributeDefNames, then these are the related actions, if blank, then just do allattributeDefTypesToReplace
- if replacing attributeDefNames, then these are the related attributeDefTypes, if blank, then just do all- Returns:
- the results
-
assignAttributesLite
public WsAssignAttributesLiteResults assignAttributesLite(String clientVersion, String attributeAssignType, String wsAttributeDefNameName, String wsAttributeDefNameId, String attributeAssignOperation, String valueId, String valueSystem, String valueFormatted, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, String attributeAssignValueOperation, String wsAttributeAssignId, String wsOwnerGroupName, String wsOwnerGroupId, String wsOwnerStemName, String wsOwnerStemId, String wsOwnerSubjectId, String wsOwnerSubjectSourceId, String wsOwnerSubjectIdentifier, String wsOwnerMembershipId, String wsOwnerMembershipAnyGroupName, String wsOwnerMembershipAnyGroupId, String wsOwnerMembershipAnySubjectId, String wsOwnerMembershipAnySubjectSourceId, String wsOwnerMembershipAnySubjectIdentifier, String wsOwnerAttributeDefName, String wsOwnerAttributeDefId, String wsOwnerAttributeAssignId, String action, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) assign attributes and values to owner objects (groups, stems, etc)- Parameters:
attributeAssignType
- Type of owner, from enum AttributeAssignType, e.g. group, member, stem, any_mem, imm_mem, attr_def, group_asgn, mem_asgn, stem_asgn, any_mem_asgn, imm_mem_asgn, attr_def_asgnclientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeAssignId
- if you know the assign id you want, put id herewsOwnerGroupName
- is group to look inwsOwnerGroupId
- is group to look inwsOwnerSubjectId
- is subject to look inwsOwnerSubjectSourceId
- is subject to look inwsOwnerSubjectIdentifier
- is subject to look inwsAttributeDefNameName
- attribute def name to assign to the ownerwsAttributeDefNameId
- attribute def name to assign to the ownerattributeAssignOperation
- operation to perform for attribute on owners, from enum AttributeAssignOperation assign_attr, add_attr, remove_attrvalueId
- If removing, and id is specified, will only remove values with that id.valueSystem
- is value to add, assign, remove, etcvalueFormatted
- is value to add, assign, remove, etc though not implemented yetassignmentNotes
- notes on the assignment (optional)assignmentEnabledTime
- enabled time, or null for enabled nowassignmentDisabledTime
- disabled time, or null for not disableddelegatable
- really only for permissions, if the assignee can delegate to someone else. TRUE|FALSE|GRANTattributeAssignValueOperation
- operation to perform for attribute value on attribute assignments: assign_value, add_value, remove_value, replace_valueswsOwnerStemName
- is stem to look inwsOwnerStemId
- is stem to look inwsOwnerMembershipId
- to query attributes on immediate membershipwsOwnerMembershipAnyGroupName
- to query attributes in "any" membership which is on immediate or effective membershipwsOwnerMembershipAnyGroupId
- to query attributes in "any" membership which is on immediate or effective membershipwsOwnerMembershipAnySubjectId
- to query attributes in "any" membership which is on immediate or effective membershipwsOwnerMembershipAnySubjectSourceId
- to query attributes in "any" membership which is on immediate or effective membershipwsOwnerMembershipAnySubjectIdentifier
- to query attributes in "any" membership which is on immediate or effective membershipwsOwnerAttributeDefName
- to query attributes assigned on attribute defwsOwnerAttributeDefId
- to query attributes assigned on attribute defwsOwnerAttributeAssignId
- for assignment on assignmentaction
- to assign, or "assign" is the default if blankincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectId
- act as this subjectactAsSubjectSourceId
- act as this subjectactAsSubjectIdentifier
- act as this subjectwsAttributeAssignLookups
- lookups to remove etcsubjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- Returns:
- the results
-
getPermissionAssignments
public WsGetPermissionAssignmentsResults getPermissionAssignments(String clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsGroupLookup[] roleLookups, WsSubjectLookup[] wsSubjectLookups, String[] actions, String includePermissionAssignDetail, String includeAttributeDefNames, String includeAttributeAssignments, String includeAssignmentsOnAssignments, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, String enabled) get permissionAssignments from roles etc based on inputs- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000roleLookups
- are roles to look inwsSubjectLookups
- are subjects to look inwsAttributeDefLookups
- find assignments in these attribute defs (optional)wsAttributeDefNameLookups
- find assignments in these attribute def names (optional)actions
- to query, or none to query all actionsincludeAttributeDefNames
- T or F for if attributeDefName objects should be returnedincludeAttributeAssignments
- T or F for it attribute assignments should be returnedincludeAssignmentsOnAssignments
- if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.includePermissionAssignDetail
- T or F for if the permission details should be returnedincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectLookup
-subjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparams
- optional: reserved for future useenabled
- is A for all, T or null for enabled only, F for disabled- Returns:
- the results
-
getPermissionAssignmentsLite
public WsGetPermissionAssignmentsResults getPermissionAssignmentsLite(String clientVersion, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String roleName, String roleId, String wsSubjectId, String wsSubjectSourceId, String wsSubjectIdentifier, String action, String includePermissionAssignDetail, String includeAttributeDefNames, String includeAttributeAssignments, String includeAssignmentsOnAssignments, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String enabled) get permissionAssignments from role etc based on inputs- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000roleName
- is role to look inroleId
- is role to look inwsAttributeDefName
- find assignments in this attribute def (optional)wsAttributeDefId
- find assignments in this attribute def (optional)wsAttributeDefNameName
- find assignments in this attribute def name (optional)wsAttributeDefNameId
- find assignments in this attribute def name (optional)wsSubjectId
- is subject to look inwsSubjectSourceId
- is subject to look inwsSubjectIdentifier
- is subject to look inaction
- to query, or none to query all actionsincludeAttributeDefNames
- T or F for if attributeDefName objects should be returnedincludeAttributeAssignments
- T or F for it attribute assignments should be returnedincludeAssignmentsOnAssignments
- if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.includePermissionAssignDetail
- T or F for if the permission details should be returnedincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectId
- act as this subject (if allowed)actAsSubjectSourceId
- act as this subject (if allowed)actAsSubjectIdentifier
- act as this subject (if allowed)subjectAttributeNames
- are the additional subject attributes (data) to return (comma separated) If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparamName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future useenabled
- is A for all, T or null for enabled only, F for disabled- Returns:
- the results
-
assignPermissions
public WsAssignPermissionsResults assignPermissions(String clientVersion, String permissionType, WsAttributeDefNameLookup[] permissionDefNameLookups, String permissionAssignOperation, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsGroupLookup[] roleLookups, WsMembershipAnyLookup[] subjectRoleLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, WsAttributeDefLookup[] attributeDefsToReplace, String[] actionsToReplace) assign permissions to roles or subjects (in the context of a role)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000permissionType
- is role or role_subject from the PermissionType enumroleLookups
- are groups to assign to for permissionType "role"subjectRoleLookups
- are subjects to assign to, in the context of a role (for permissionType "subject_role")permissionDefNameLookups
- attribute def names to assign to the owners (required)permissionAssignOperation
- operation to perform for permission on role or subject, from enum PermissionAssignOperation assign_permission, remove_permissionassignmentNotes
- notes on the assignment (optional)assignmentEnabledTime
- enabled time, or null for enabled nowassignmentDisabledTime
- disabled time, or null for not disableddelegatable
- if the assignee can delegate to someone else. TRUE|FALSE|GRANTactions
- to assign, or "assign" is the default if blankincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)actAsSubjectLookup
-wsAttributeAssignLookups
- lookups to remove etcsubjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparams
- optional: reserved for future useattributeDefsToReplace
- if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do allactionsToReplace
- if replacing attributeDefNames, then these are the related actions, if blank, then just do all- Returns:
- the results
-
assignPermissionsLite
public WsAssignPermissionsLiteResults assignPermissionsLite(String clientVersion, String permissionType, String permissionDefNameName, String permissionDefNameId, String permissionAssignOperation, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, String wsAttributeAssignId, String roleName, String roleId, String subjectRoleName, String subjectRoleId, String subjectRoleSubjectId, String subjectRoleSubjectSourceId, String subjectRoleSubjectIdentifier, String action, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1) assign permissions to role or subject (in the context of a role)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000permissionType
- is role or role_subject from the PermissionType enumpermissionDefNameName
- attribute def name to assign to the owner (required)permissionDefNameId
- attribute def name to assign to the owner (required)roleName
- is group to assign to for permissionType "role"roleId
- is group to assign to for permissionType "role"permissionAssignOperation
- operation to perform for permission on role or subject, from enum PermissionAssignOperation assign_permission, remove_permissionassignmentNotes
- notes on the assignment (optional)assignmentEnabledTime
- enabled time, or null for enabled nowassignmentDisabledTime
- disabled time, or null for not disableddelegatable
- if the assignee can delegate to someone else. TRUE|FALSE|GRANTaction
- to assign, or "assign" is the default if blankincludeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)wsAttributeAssignId
- lookup to remove etcsubjectRoleName
- is role name if assigning to subject, in the context of a role (for permissionType "subject_role")subjectRoleId
- is role id if assigning to subject, in the context of a role (for permissionType "subject_role")subjectRoleSubjectId
- is subject id if assigning to subject, in the context of a role (for permissionType "subject_role")subjectRoleSubjectSourceId
- is subject source id if assigning to subject, in the context of a role (for permissionType "subject_role")subjectRoleSubjectIdentifier
- is subject identifier if assigning to subject, in the context of a role (for permissionType "subject_role")actAsSubjectId
- if acting as someone elseactAsSubjectSourceId
- if acting as someone elseactAsSubjectIdentifier
- if acting as someone elsesubjectAttributeNames
- are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sentincludeGroupDetail
- T or F as to if the group detail should be returnedparamName0
- optional: reserved for future useparamValue0
- optional: reserved for future useparamName1
- optional: reserved for future useparamValue1
- optional: reserved for future use- Returns:
- the results
-