Class GrouperService
java.lang.Object
edu.internet2.middleware.grouper.ws.coresoap.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 TypeMethodDescriptionacknowledge
(String clientVersion, String queueOrTopicName, String messageSystemName, String acknowledgeType, String[] messageIds, String anotherQueueOrTopicName, String anotherQueueType, WsSubjectLookup actAsSubjectLookup, WsParam[] params) 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, String addExternalSubjectIfNotFound) 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, String addExternalSubjectIfNotFound) add member to a group (if already a direct member, ignore)assignAttributeDefActions
(String clientVersion, WsAttributeDefLookup wsAttributeDefLookup, String[] actions, String assign, String replaceAllExisting, WsSubjectLookup actAsSubjectLookup, WsParam[] params) assignAttributeDefNameInheritance
(String clientVersion, WsAttributeDefNameLookup wsAttributeDefNameLookup, WsAttributeDefNameLookup[] relatedWsAttributeDefNameLookups, String assign, String replaceAllExisting, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) assign or unassign attribute def name permission inheritanceassignAttributeDefNameInheritanceLite
(String clientVersion, String attributeDefNameUuid, String attributeDefNameName, String relatedAttributeDefNameUuid, String relatedAttributeDefNameName, String assign, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) assign or unassign attribute def name permission inheritanceassignAttributes
(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)assignAttributesBatch
(String clientVersion, WsAssignAttributeBatchEntry[] wsAssignAttributeBatchEntries, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String txType, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params) assign attributes and values to owner objects (groups, stems, etc), doing multiple operations in one batchassignAttributesLite
(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, String disallowed) 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, String disallowed) assign permissions to role or subject (in the context of a role)attributeDefDelete
(String clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) delete an attribute def or many (if doesnt exist, ignore)attributeDefDeleteLite
(String clientVersion, String wsNameOfAttributeDef, String wsIdOfAttributeDef, String wsIdIndexOfAttributeDef, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) delete an attribute defattributeDefNameDelete
(String clientVersion, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) delete an AttributeDefName or many.attributeDefNameDeleteLite
(String clientVersion, String attributeDefNameUuid, String attributeDefNameName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) delete an AttributeDefNameattributeDefNameSave
(String clientVersion, WsAttributeDefNameToSave[] wsAttributeDefNameToSaves, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) save an AttributeDefName or many (insert or update).attributeDefNameSaveLite
(String clientVersion, String attributeDefNameLookupUuid, String attributeDefNameLookupName, String attributeDefLookupUuid, String attributeDefLookupName, String attributeDefNameUuid, String attributeDefNameName, String displayExtension, String description, String saveMode, String createParentStemsIfNotExist, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) save an AttributeDefName (insert or update).attributeDefSave
(String clientVersion, WsAttributeDefToSave[] wsAttributeDefsToSave, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) save an AttributeDef or many (insert or update).attributeDefSaveLite
(String clientVersion, String attributeDefLookupUuid, String attributeDefLookupName, String uuidOfAttributeDef, String nameOfAttributeDef, String assignToAttributeDef, String assignToAttributeDefAssignment, String assignToEffectiveMembership, String assignToEffectiveMembershipAssignment, String assignToGroup, String assignToGroupAssignment, String assignToImmediateMembership, String assignToImmediateMembershipAssignment, String assignToMember, String assignToMemberAssignment, String assignToStem, String assignToStemAssignment, String attributeDefType, String multiAssignable, String multiValued, String valueType, String description, String saveMode, String createParentStemsIfNotExist, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) save an AttributeDef (insert or update).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)externalSubjectDelete
(String clientVersion, WsExternalSubjectLookup[] wsExternalSubjectLookups, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) delete an external subject or many (if doesnt exist, ignore)externalSubjectSave
(String clientVersion, WsExternalSubjectToSave[] wsExternalSubjectToSaves, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) save an external subject (insert or update).findAttributeDefNames
(String clientVersion, String scope, String splitScope, WsAttributeDefLookup wsAttributeDefLookup, String attributeAssignType, String attributeDefType, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, String pageSize, String pageNumber, String sortString, String ascending, String wsInheritanceSetRelation, WsSubjectLookup actAsSubjectLookup, WsParam[] params, WsSubjectLookup wsSubjectLookup, String serviceRole, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) find an attribute def name or attribute def names.findAttributeDefNamesLite
(String clientVersion, String scope, String splitScope, String uuidOfAttributeDef, String nameOfAttributeDef, String attributeAssignType, String attributeDefType, String attributeDefNameUuid, String attributeDefNameName, String pageSize, String pageNumber, String sortString, String ascending, String wsInheritanceSetRelation, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, String subjectId, String subjectSourceId, String subjectIdentifier, String serviceRole, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) find an attribute def name or attribute def names.findAttributeDefs
(String clientVersion, String scope, String splitScope, WsAttributeDefLookup[] wsAttributeDefLookups, String privilegeName, String stemScope, String parentStemId, String findByUuidOrName, String pageSize, String pageNumber, String sortString, String ascending, WsSubjectLookup actAsSubjectLookup, WsParam[] params, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) find an attribute def or attribute defs.findAttributeDefsLite
(String clientVersion, String scope, String splitScope, String uuidOfAttributeDef, String nameOfAttributeDef, String idIndexOfAttributeDef, String privilegeName, String stemScope, String parentStemId, String findByUuidOrName, String pageSize, String pageNumber, String sortString, String ascending, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) find an attribute def name attribute defs.findExternalSubjects
(String clientVersion, WsExternalSubjectLookup[] wsExternalSubjectLookups, WsSubjectLookup actAsSubjectLookup, WsParam[] params) find a external subjectsfindGroups
(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, String pageSize, String pageNumber, String sortString, String ascending, String typeOfGroups, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String enabled) 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 stemsgetAttributeAssignActions
(String clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, WsParam[] params) get attributeAssignActions from based on inputsgetAttributeAssignActionsLite
(String clientVersion, String wsNameOfAttributeDef, String wsIdOfAtttributeDef, String wsIdIndexOfAtrrbuteDef, String action, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) get attributeAssignActions based on inputsgetAttributeAssignments
(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, String attributeDefValueType, String theValue, String includeAssignmentsFromAssignments, String attributeDefType, WsAttributeAssignLookup[] wsAssignAssignOwnerAttributeAssignLookups, WsAttributeDefLookup[] wsAssignAssignOwnerAttributeDefLookups, WsAttributeDefNameLookup[] wsAssignAssignOwnerAttributeDefNameLookups, String[] wsAssignAssignOwnerActions) 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, String attributeDefValueType, String theValue, String includeAssignmentsFromAssignments, String attributeDefType, String wsAssignAssignOwnerAttributeAssignId, String wsAssignAssignOwnerIdOfAttributeDef, String wsAssignAssignOwnerNameOfAttributeDef, String wsAssignAssignOwnerIdOfAttributeDefName, String wsAssignAssignOwnerNameOfAttributeDefName, String wsAssignAssignOwnerAction) get attributeAssignments based on inputsgetAuditEntries
(String clientVersion, WsSubjectLookup actAsSubjectLookup, String auditType, String auditActionId, WsGroupLookup wsGroupLookup, WsStemLookup wsStemLookup, WsAttributeDefLookup wsAttributeDefLookup, WsAttributeDefNameLookup wsAttributeDefNameLookup, WsSubjectLookup wsSubjectLookup, WsSubjectLookup actionsPerformedByWsSubjectLookup, WsParam[] params, String pageSize, String sortString, String ascending, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String fromDate, String toDate) get audit entriesgetAuditEntriesLite
(String clientVersion, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String auditType, String auditActionId, String wsGroupName, String wsGroupId, String wsStemName, String wsStemId, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String wsSubjectId, String wsSubjectSourceId, String wsSubjectIdentifier, String actionsPerformedByWsSubjectId, String actionsPerformedByWsSubjectSourceId, String actionsPerformedByWsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, String pageSize, String sortString, String ascending, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String pointInTimeFrom, String pointInTimeTo) get audit entriesgetGrouperPrivilegesLite
(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, String pointInTimeFrom, String pointInTimeTo, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) 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, String pointInTimeFrom, String pointInTimeTo, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) 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, String pointInTimeFrom, String pointInTimeTo, String pageSize, String pageNumber, String sortString, String ascending, String pointInTimeRetrieve, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) 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, WsStemLookup[] wsOwnerStemLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, String fieldType, String serviceRole, WsAttributeDefNameLookup serviceLookup, String pageSize, String pageNumber, String sortString, String ascending, String pageSizeForMember, String pageNumberForMember, String sortStringForMember, String ascendingForMember, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String pageIsCursorForMember, String pageLastCursorFieldForMember, String pageLastCursorFieldTypeForMember, String pageCursorFieldIncludesLastRetrievedForMember, String pointInTimeRetrieve, String pointInTimeFrom, String pointInTimeTo) 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, String ownerStemName, String ownerStemUuid, String nameOfOwnerAttributeDef, String ownerAttributeDefUuid, String fieldType, String serviceRole, String serviceId, String serviceName, String pageSize, String pageNumber, String sortString, String ascending, String pageSizeForMember, String pageNumberForMember, String sortStringForMember, String ascendingForMember, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String pageIsCursorForMember, String pageLastCursorFieldForMember, String pageLastCursorFieldTypeForMember, String pageCursorFieldIncludesLastRetrievedForMember, String pointInTimeRetrieve, String pointInTimeFrom, String pointInTimeTo) 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, String pointInTimeFrom, String pointInTimeTo, String pageSize, String pageNumber, String sortString, String ascending, String pointInTimeRetrieve, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) 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, String pointInTimeFrom, String pointInTimeTo, String immediateOnly, String permissionType, String permissionProcessor, WsPermissionEnvVar[] limitEnvVars, String includeLimits) 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, String pointInTimeFrom, String pointInTimeTo, String immediateOnly, String permissionType, String permissionProcessor, String limitEnvVarName0, String limitEnvVarValue0, String limitEnvVarType0, String limitEnvVarName1, String limitEnvVarValue1, String limitEnvVarType1, String includeLimits) 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, String typeOfGroup1, String alternateName, String disabledTime, String enabledTime) 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, String pointInTimeFrom, String pointInTimeTo) 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, String pointInTimeFrom, String pointInTimeTo) 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)receiveMessage
(String clientVersion, String queueType, String queueOrTopicName, String messageSystemName, String routingKey, String exchangeType, Map<String, Object> queueArguments, String autocreateObjects, String blockMillis, String maxMessagesToReceiveAtOnce, WsSubjectLookup actAsSubjectLookup, WsParam[] params) sendMessage
(String clientVersion, String queueType, String queueOrTopicName, String messageSystemName, String routingKey, String exchangeType, Map<String, Object> queueArguments, String autocreateObjects, WsMessage[] messages, WsSubjectLookup actAsSubjectLookup, WsParam[] params) 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 -
GrouperService
public GrouperService(boolean soap1) - Parameters:
soap1
-
-
-
Method Details
-
findGroupsLite
@POST @Path("/grouper-ws/servicesRest/vF_G_UPL/groups") 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, String pageSize, String pageNumber, String sortString, String ascending, String typeOfGroups, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String enabled) 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 usepageSize
- 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 stringpageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved itemtypeOfGroups
- is the comma separated TypeOfGroups to find, e.g. group, role, entityenabled
- enabled is A for all, T or null for enabled only, F for disabled- 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
@POST @Path("/grouper-ws/servicesRest/vG_E_MEL/members") 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, String pointInTimeFrom, String pointInTimeTo, String pageSize, String pageNumber, String sortString, String ascending, String pointInTimeRetrieve, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) 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 allpointInTimeRetrieve
- true means retrieve point in time recordspointInTimeFrom
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSSpointInTimeTo
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSSpageSize
- page size if pagingpageNumber
- page number 1 indexed if pagingsortString
- must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, name, description, sortString0, sortString1, sortString2, sortString3, sortString4ascending
- T or null for ascending, F for descending.pageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved item- 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, String pointInTimeFrom, String pointInTimeTo, String pageSize, String pageNumber, String sortString, String ascending, String pointInTimeRetrieve, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) 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 allpointInTimeRetrieve
- true means retrieve point in time recordspointInTimeFrom
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSSpointInTimeTo
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSSpageSize
- page size if pagingpageNumber
- page number 1 indexed if pagingsortString
- must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, name, description, sortString0, sortString1, sortString2, sortString3, sortString4ascending
- T or null for ascending, F for descending.pageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved item- 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, String pointInTimeFrom, String pointInTimeTo, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) 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 stringpageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved itempointInTimeFrom
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSSpointInTimeTo
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS- 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, String pointInTimeFrom, String pointInTimeTo) 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 usepointInTimeFrom
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSSpointInTimeTo
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS- Returns:
- the results
-
stemDeleteLite
@POST @Path("/grouper-ws/servicesRest/vS_T_DEL/stems") 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
@POST @Path("/grouper-ws/servicesRest/vG_R_DEL/groups") 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
@POST @Path("/grouper-ws/servicesRest/vG_R_SAL/groups") 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, String typeOfGroup1, String alternateName, String disabledTime, String enabledTime) 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 usetypeOfGroup1
- type of group can be an enum of TypeOfGroup, e.g. group, role, entityalternateName
- the alternate name of the groupdisabledTime
-enabledTime
-- Returns:
- the result of one member add
-
stemSaveLite
@POST @Path("/grouper-ws/servicesRest/vS_T_SAL/stems") 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, String addExternalSubjectIfNotFound) 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.SSSaddExternalSubjectIfNotFound
- T or F, if this is a search by id or identifier, with no source, or the external source, and the subject is not found, then add an external subject (if the user is allowed- 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
@POST @Path("/grouper-ws/servicesRest/vG_E_GRL/groups") 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, String pointInTimeFrom, String pointInTimeTo, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) 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 stringpageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved itempointInTimeFrom
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSSpointInTimeTo
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS- Returns:
- the result of one member add
-
addMemberLite
@POST @Path("/grouper-ws/servicesRest/vA_A_MEL/members") 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, String addExternalSubjectIfNotFound) 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.SSSaddExternalSubjectIfNotFound
- T or F, if this is a search by id or identifier, with no source, or the external source, and the subject is not found, then add an external subject (if the user is allowed- Returns:
- the result of one member add
-
hasMemberLite
@POST @Path("/grouper-ws/servicesRest/vH_M_EML/members") 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, String pointInTimeFrom, String pointInTimeTo) 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 usepointInTimeFrom
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSSpointInTimeTo
- To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS- Returns:
- the result of one member query
-
memberChangeSubjectLite
@POST @Path("/grouper-ws/servicesRest/vM_C_SUL/members") 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
@POST @Path("/grouper-ws/servicesRest/vD_M_EML/members") 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
@POST @Path("/grouper-ws/servicesRest/vF_S_EML/stems") 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
@POST @Path("/grouper-ws/servicesRest/vG_E_GPL/grouperPrivileges") 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
@POST @Path("/grouper-ws/servicesRest/vA_G_PRL/grouperPrivileges") 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, groupAttrRead, groupAttrUpdate. e.g. for stems: create, stemAttrRead, stemAdmin, stemView, stemAttrUpdate)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, WsStemLookup[] wsOwnerStemLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, String fieldType, String serviceRole, WsAttributeDefNameLookup serviceLookup, String pageSize, String pageNumber, String sortString, String ascending, String pageSizeForMember, String pageNumberForMember, String sortStringForMember, String ascendingForMember, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String pageIsCursorForMember, String pageLastCursorFieldForMember, String pageLastCursorFieldTypeForMember, String pageCursorFieldIncludesLastRetrievedForMember, String pointInTimeRetrieve, String pointInTimeFrom, String pointInTimeTo) 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 knownwsOwnerStemLookups
- are the stem lookups if looking for stem privilegeswsOwnerAttributeDefLookups
- are the attribute definition lookups if looking for attribute definition privilegesfieldType
- is the type of field to look at, e.g. list (default, memberships), access (privs on groups), attribute_def (privs on attribute definitions), naming (privs on folders)serviceRole
- to filter attributes that a user has a certain roleserviceLookup
- if filtering by users in a service, then this is the service to look inpageSize
- 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
- T or null for ascending, F for descending.pageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved itempageSizeForMember
- page size if paging in the members partpageNumberForMember
- page number 1 indexed if paging in the members partsortStringForMember
- must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, sourceString0, sortString1, sortString2, sortString3, sortString4, name, description in the members partascendingForMember
- T or null for ascending, F for descending in the members partpageIsCursorForMember
- true means cursor based pagingpageLastCursorFieldForMember
- field based on which paging needs to occurpageLastCursorFieldTypeForMember
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrievedForMember
- should the result has last retrieved itempointInTimeRetrieve
- true means retrieve point in time recordspointInTimeFrom
- To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSSpointInTimeTo
- To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS- Returns:
- the results
-
getMembershipsLite
@POST @Path("/grouper-ws/servicesRest/vG_E_MSL/memberships") 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, String ownerStemName, String ownerStemUuid, String nameOfOwnerAttributeDef, String ownerAttributeDefUuid, String fieldType, String serviceRole, String serviceId, String serviceName, String pageSize, String pageNumber, String sortString, String ascending, String pageSizeForMember, String pageNumberForMember, String sortStringForMember, String ascendingForMember, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String pageIsCursorForMember, String pageLastCursorFieldForMember, String pageLastCursorFieldTypeForMember, String pageCursorFieldIncludesLastRetrievedForMember, String pointInTimeRetrieve, String pointInTimeFrom, String pointInTimeTo) 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 retrieveownerStemName
- if looking for privileges on stems, put the stem name to look for hereownerStemUuid
- if looking for privileges on stems, put the stem uuid herenameOfOwnerAttributeDef
- if looking for privileges on attribute definitions, put the name of the attribute definition hereownerAttributeDefUuid
- if looking for privileges on attribute definitions, put the uuid of the attribute definition herefieldType
- is the type of field to look at, e.g. list (default, memberships), access (privs on groups), attribute_def (privs on attribute definitions), naming (privs on folders)serviceRole
- to filter attributes that a user has a certain roleserviceId
- if filtering by users in a service, then this is the service to look in, mutually exclusive with serviceNameserviceName
- if filtering by users in a service, then this is the service to look in, mutually exclusive with serviceIdpageSize
- 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
- T or null for ascending, F for descending.pageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved itempageSizeForMember
- page size if paging in the members partpageNumberForMember
- page number 1 indexed if paging in the members partsortStringForMember
- must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, sourceString0, sortString1, sortString2, sortString3, sortString4, name, description in the members partascendingForMember
- T or null for ascending, F for descending in the members partpageIsCursorForMember
- true means cursor based pagingpageLastCursorFieldForMember
- field based on which paging needs to occurpageLastCursorFieldTypeForMember
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrievedForMember
- should the result has last retrieved itempointInTimeRetrieve
- true means retrieve point in time recordspointInTimeFrom
- To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSSpointInTimeTo
- To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS- 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
@POST @Path("/grouper-ws/servicesRest/vG_E_SUL/subjects") 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
-replaceAllExisting
- optional: T or F (default), If replaceAllExisting is T, then allowed must be set to T. This will assign the provided privilege(s) to the provided subject(s), and remove it from all other subjects who are assigned. If F or blank, assign or remove (depending on value provided in 'allowed') the provided privilege(s) from the provided subject(s)actAsSubjectLookup
- 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, String attributeDefValueType, String theValue, String includeAssignmentsFromAssignments, String attributeDefType, WsAttributeAssignLookup[] wsAssignAssignOwnerAttributeAssignLookups, WsAttributeDefLookup[] wsAssignAssignOwnerAttributeDefLookups, WsAttributeDefNameLookup[] wsAssignAssignOwnerAttributeDefNameLookups, String[] wsAssignAssignOwnerActions) 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 disabledattributeDefValueType
- required if sending theValue, can be: floating, integer, memberId, string, timestamptheValue
- value if you are passing in one attributeDefNameLookupincludeAssignmentsFromAssignments
- T|F if you are finding an assignment that is an assignmentOnAssignment, then get the assignment which tells you the owner as wellattributeDefType
- null for all, or specify an AttributeDefType e.g. attr, limit, service, type, limit, permwsAssignAssignOwnerAttributeAssignLookups
- if looking for assignments on assignments, this is the assignment the assignment is assigned towsAssignAssignOwnerAttributeDefLookups
- if looking for assignments on assignments, this is the attribute definition of the assignment the assignment is assigned towsAssignAssignOwnerAttributeDefNameLookups
- if looking for assignments on assignments, this is the attribute def name of the assignment the assignment is assigned towsAssignAssignOwnerActions
- if looking for assignments on assignments, this are the actions of the assignment the assignment is assigned to- Returns:
- the results
-
getAttributeAssignmentsLite
@POST @Path("/grouper-ws/servicesRest/vG_E_ABL/attributeAssignments") 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, String attributeDefValueType, String theValue, String includeAssignmentsFromAssignments, String attributeDefType, String wsAssignAssignOwnerAttributeAssignId, String wsAssignAssignOwnerIdOfAttributeDef, String wsAssignAssignOwnerNameOfAttributeDef, String wsAssignAssignOwnerIdOfAttributeDefName, String wsAssignAssignOwnerNameOfAttributeDefName, String wsAssignAssignOwnerAction) 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 disabledattributeDefValueType
- required if sending theValue, can be: floating, integer, memberId, string, timestampattributeDefValueType
- required if sending theValue, can be: floating, integer, memberId, string, timestamptheValue
- value assigned to an attribute that you are searching forincludeAssignmentsFromAssignments
- T|F if you are finding an assignment that is an assignmentOnAssignment, then get the assignment which tells you the owner as wellattributeDefType
- null for all, or specify an AttributeDefType e.g. attr, limit, service, type, limit, permwsAssignAssignOwnerAttributeAssignId
- if looking for assignments on assignments, this is the assignment the assignment is assigned towsAssignAssignOwnerIdOfAttributeDef
- if looking for assignments on assignments, this is the attribute definition of the assignment the assignment is assigned towsAssignAssignOwnerNameOfAttributeDef
- if looking for assignments on assignments, this is the attribute definition of the assignment the assignment is assigned towsAssignAssignOwnerIdOfAttributeDefName
- if looking for assignments on assignments, this is the attribute def name of the assignment the assignment is assigned towsAssignAssignOwnerNameOfAttributeDefName
- if looking for assignments on assignments, this is the attribute def name of the assignment the assignment is assigned towsAssignAssignOwnerAction
- if looking for assignments on assignments, this is the action of the assignment the assignment is assigned to- Returns:
- the results
-
assignAttributeDefActions
public WsAttributeDefAssignActionResults assignAttributeDefActions(String clientVersion, WsAttributeDefLookup wsAttributeDefLookup, String[] actions, String assign, String replaceAllExisting, WsSubjectLookup actAsSubjectLookup, WsParam[] params) - Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeDefLookup
- is the attribute definition to be modifiedactions
- to assignassign
- T to assign, or F to remove assignmentreplaceAllExisting
- T if assigning, if this list should replace all existing actionsactAsSubjectLookup
-params
- optional: reserved for future use- Returns:
- the results
-
getAttributeAssignActions
public WsGetAttributeAssignActionsResults getAttributeAssignActions(String clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, WsParam[] params) get attributeAssignActions from based on inputs- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeDefLookups
- find assignments in these attribute defsactions
- to query, or none to query all actionsactAsSubjectLookup
-params
- optional: reserved for future use- Returns:
- the results
-
getAttributeAssignActionsLite
@POST @Path("/grouper-ws/servicesRest/vG_E_ABL/attributeAssignActions") public WsGetAttributeAssignActionsResults getAttributeAssignActionsLite(String clientVersion, String wsNameOfAttributeDef, String wsIdOfAtttributeDef, String wsIdIndexOfAtrrbuteDef, String action, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) get attributeAssignActions based on inputs- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsNameOfAttributeDef
- find assignActions in this attribute defwsIdOfAtttributeDef
- find assignments in this attribute def (optional)wsIdIndexOfAtrrbuteDef
- find assignments in this attribute def (optional)action
- to query, or none to query all actionsactAsSubjectId
-actAsSubjectSourceId
-actAsSubjectIdentifier
-paramName0
- reserved for future useparamValue0
- reserved for future useparamName1
- reserved for future useparamValue1
- reserved for future use- 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
-
assignAttributesBatch
public WsAssignAttributesBatchResults assignAttributesBatch(String clientVersion, WsAssignAttributeBatchEntry[] wsAssignAttributeBatchEntries, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String txType, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params) assign attributes and values to owner objects (groups, stems, etc), doing multiple operations in one batch- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000includeSubjectDetail
- T|F, for if the extended subject information should be returned (anything more than just the id)wsAssignAttributeBatchEntries
- batch of attribute assignmentsactAsSubjectLookup
-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 usetxType
- 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.- Returns:
- the results
-
assignAttributesLite
@POST @Path("/grouper-ws/servicesRest/vA_E_ATL/attributeAssignments") 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, String pointInTimeFrom, String pointInTimeTo, String immediateOnly, String permissionType, String permissionProcessor, WsPermissionEnvVar[] limitEnvVars, String includeLimits) 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 disabledpointInTimeFrom
- To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSSpointInTimeTo
- To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSSimmediateOnly
- T of F (defaults to F) if we should filter out non immediate permissionspermissionType
- are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject. defaults to role_subject permissionspermissionProcessor
- if we should find the best answer, or process limits, etc. From the enum PermissionProcessor. example values are: FILTER_REDUNDANT_PERMISSIONS, FILTER_REDUNDANT_PERMISSIONS_AND_PROCESS_LIMITS, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES_AND_PROCESS_LIMITS, PROCESS_LIMITSlimitEnvVars
- limitEnvVars if processing limits, pass in a set of limits. The name is the name of the variable, and the value is the value. Note, you can typecast the values by putting a valid type in parens in front of the param name. e.g. name: (int)amount, value: 50includeLimits
- T or F (default to F) for if limits should be returned with the results. Note that the attributeDefs, attributeDefNames, and attributeAssignments will be added to those lists- Returns:
- the results
-
getPermissionAssignmentsLite
@POST @Path("/grouper-ws/servicesRest/vG_E_PAL/permissionAssignments") 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, String pointInTimeFrom, String pointInTimeTo, String immediateOnly, String permissionType, String permissionProcessor, String limitEnvVarName0, String limitEnvVarValue0, String limitEnvVarType0, String limitEnvVarName1, String limitEnvVarValue1, String limitEnvVarType1, String includeLimits) 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 disabledpointInTimeFrom
- To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSSpointInTimeTo
- To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSSimmediateOnly
- T of F (defaults to F) if we should filter out non immediate permissionspermissionType
- are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject. defaults to role_subject permissionspermissionProcessor
- if we should find the best answer, or process limits, etc. From the enum PermissionProcessor. example values are: FILTER_REDUNDANT_PERMISSIONS, FILTER_REDUNDANT_PERMISSIONS_AND_PROCESS_LIMITS, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES_AND_PROCESS_LIMITS, PROCESS_LIMITSlimitEnvVarName0
- limitEnvVars if processing limits, pass in a set of limits. The name is the name of the variable, and the value is the value. Note, you can typecast the values by putting a valid type in parens in front of the param name. e.g. name: (int)amount, value: 50limitEnvVarValue0
- first limit env var valuelimitEnvVarType0
- first limit env var typelimitEnvVarName1
- second limit env var namelimitEnvVarValue1
- second limit env var valuelimitEnvVarType1
- second limit env var typeincludeLimits
- T or F (default to F) for if limits should be returned with the results. Note that the attributeDefs, attributeDefNames, and attributeAssignments will be added to those lists- 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, String disallowed) 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 alldisallowed
- T or F if the permission is disallowed- Returns:
- the results
-
assignPermissionsLite
@POST @Path("/grouper-ws/servicesRest/vA_H_PRL/permissionAssignments") 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, String disallowed) 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 usedisallowed
- T or F if the permission is disallowed- Returns:
- the results
-
assignAttributeDefNameInheritance
public WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritance(String clientVersion, WsAttributeDefNameLookup wsAttributeDefNameLookup, WsAttributeDefNameLookup[] relatedWsAttributeDefNameLookups, String assign, String replaceAllExisting, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) assign or unassign attribute def name permission inheritance- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeDefNameLookup
- attributeDefName which is the container for the inherited attribute def namesrelatedWsAttributeDefNameLookups
- one or many attribute def names to add or remove from inheritance from the containerassign
- T to assign, or F to remove assignmentreplaceAllExisting
- T if assigning, if this list should replace all existing immediately inherited attribute def namesactAsSubjectLookup
- if searching as someone else, pass in that subject here, note the caller must be allowed to act as that other subjecttxType
- 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
-
assignAttributeDefNameInheritanceLite
@POST @Path("/grouper-ws/servicesRest/vA_D_ANL/attributeDefNames") public WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritanceLite(String clientVersion, String attributeDefNameUuid, String attributeDefNameName, String relatedAttributeDefNameUuid, String relatedAttributeDefNameName, String assign, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) assign or unassign attribute def name permission inheritance- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000attributeDefNameUuid
- id of attributeDefName which is the container for the inherited attribute def names, mutually exclusive with attributeDefNameNameattributeDefNameName
- name of attributeDefName which is the container for the inherited attribute def names, mutually exclusive with attributeDefNameIdrelatedAttributeDefNameUuid
- id of attribute def name to add or remove from inheritance from the containerrelatedAttributeDefNameName
- name of attribute def name to add or remove from inheritance from the containerassign
- T to assign, or F to remove assignmentreplaceAllExisting
- T if assigning, if this list should replace all existing immediately inherited attribute def namesactAsSubjectId
- 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 result
-
attributeDefSave
public WsAttributeDefSaveResults attributeDefSave(String clientVersion, WsAttributeDefToSave[] wsAttributeDefsToSave, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) save an AttributeDef or many (insert or update). Note, you cannot rename an existing AttributeDef.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeDefsToSave
- AttributeDefs 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
-
attributeDefSaveLite
@POST @Path("/grouper-ws/servicesRest/vA_L_SAL/attributeDefs") public WsAttributeDefSaveLiteResult attributeDefSaveLite(String clientVersion, String attributeDefLookupUuid, String attributeDefLookupName, String uuidOfAttributeDef, String nameOfAttributeDef, String assignToAttributeDef, String assignToAttributeDefAssignment, String assignToEffectiveMembership, String assignToEffectiveMembershipAssignment, String assignToGroup, String assignToGroupAssignment, String assignToImmediateMembership, String assignToImmediateMembershipAssignment, String assignToMember, String assignToMemberAssignment, String assignToStem, String assignToStemAssignment, String attributeDefType, String multiAssignable, String multiValued, String valueType, String description, String saveMode, String createParentStemsIfNotExist, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) save an AttributeDef (insert or update). Note you cannot currently move an existing AttributeDef.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000attributeDefLookupUuid
- to lookup the attributeDef (mutually exclusive with attributeDefName)attributeDefLookupName
- to lookup the attributeDef (mutually exclusive with attributeDefUuid)uuidOfAttributeDef
- the uuid of the attributeDef to editnameOfAttributeDef
- the name of the attributeDef to editassignToAttributeDef
-assignToAttributeDefAssignment
-assignToEffectiveMembership
-assignToEffectiveMembershipAssignment
-assignToGroup
-assignToGroupAssignment
-assignToImmediateMembership
-assignToImmediateMembershipAssignment
-assignToMember
-assignToMemberAssignment
-assignToStem
-assignToStemAssignment
-attributeDefType
- type of attribute def, from enum AttributeDefType, e.g. attr, domain, type, limit, permmultiAssignable
- T of F for if can be assigned multiple times to one objectmultiValued
- T or F, if has values, if can assign multiple values to one assignmentvalueType
- what type of value on assignments: AttributeDefValueType: e.g. integer, timestamp, string, floating, marker, memberIddescription
- of the attributeDef, empty will be ignoredsaveMode
- if the save should be constrained to INSERT, UPDATE, or INSERT_OR_UPDATE (default)createParentStemsIfNotExist
- T or F (default F) if parent stems should be created if not existactAsSubjectId
- 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
-
attributeDefDelete
public WsAttributeDefDeleteResults attributeDefDelete(String clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) delete an attribute def or many (if doesnt exist, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeDefLookups
- attributeDefs 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.params
- optional: reserved for future use- Returns:
- the results
-
attributeDefDeleteLite
@POST @Path("/grouper-ws/servicesRest/vA_I_DEL/attributeDefs") public WsAttributeDefDeleteLiteResult attributeDefDeleteLite(String clientVersion, String wsNameOfAttributeDef, String wsIdOfAttributeDef, String wsIdIndexOfAttributeDef, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) delete an attribute def- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsNameOfAttributeDef
- name of attribute def to be deletedwsIdOfAttributeDef
- id of attribute def to be deleted.wsIdIndexOfAttributeDef
- idIndex of attribute def to be deleted.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
-
findAttributeDefs
public WsFindAttributeDefsResults findAttributeDefs(String clientVersion, String scope, String splitScope, WsAttributeDefLookup[] wsAttributeDefLookups, String privilegeName, String stemScope, String parentStemId, String findByUuidOrName, String pageSize, String pageNumber, String sortString, String ascending, WsSubjectLookup actAsSubjectLookup, WsParam[] params, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) find an attribute def or attribute defs. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000scope
- search string with % as wildcards will search name, display name, descriptionsplitScope
- T or F, if T will split the scope by whitespace, and find attribute defs with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whateverwsAttributeDefLookups
- find attributeDefs associated with these attribute defs lookupsprivilegeName
- privilegeName or null. null will default to ATTR_VIEWstemScope
- is if in this stem, or in any stem underneath. You must pass stemScope if you pass a stemparentStemId
- search in this stemfindByUuidOrName
-actAsSubjectLookup
- if searching as someone else, pass in that subject here, note the caller must be allowed to act as that other subjectparams
- optional: reserved for future usepageSize
- 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.pageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved item- Returns:
- the attribute defs, or no attribute def if none found
-
findAttributeDefsLite
@POST @Path("/grouper-ws/servicesRest/vF_A_DSL/attributeDefs") public WsFindAttributeDefsResults findAttributeDefsLite(String clientVersion, String scope, String splitScope, String uuidOfAttributeDef, String nameOfAttributeDef, String idIndexOfAttributeDef, String privilegeName, String stemScope, String parentStemId, String findByUuidOrName, String pageSize, String pageNumber, String sortString, String ascending, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) find an attribute def name attribute defs. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000scope
- search string with % as wildcards will search name, display name, descriptionsplitScope
- T or F, if T will split the scope by whitespace, and find attribute defs with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whateveruuidOfAttributeDef
- find attribute defs associated with this attribute def uuid, mutually exclusive with nameOfAttributeDefnameOfAttributeDef
- find attribute defs associated with this attribute def name, mutually exclusive with idOfAttributeDefidIndexOfAttributeDef
- find attribute defs associated with this attribute def id indexprivilegeName
- privilegeName or null. null will default to ATTR_VIEWstemScope
- is if in this stem, or in any stem underneath. You must pass stemScope if you pass a stemparentStemId
- search in this stemfindByUuidOrName
-pageSize
- 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.pageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved itemactAsSubjectId
- 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 attribute defs, or no attribute defs if none found
-
attributeDefNameDelete
public WsAttributeDefNameDeleteResults attributeDefNameDelete(String clientVersion, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) delete an AttributeDefName or many. Note, you cannot rename an existing AttributeDefName.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeDefNameLookups
- AttributeDefNames 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.params
- optional: reserved for future use- Returns:
- the results
-
attributeDefNameDeleteLite
@POST @Path("/grouper-ws/servicesRest/vA_J_DEL/attributeDefNames") public WsAttributeDefNameDeleteLiteResult attributeDefNameDeleteLite(String clientVersion, String attributeDefNameUuid, String attributeDefNameName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) delete an AttributeDefName- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000attributeDefNameUuid
- the uuid of the attributeDefName to delete (mutually exclusive with attributeDefNameName)attributeDefNameName
- the name of the attributeDefName to delete (mutually exclusive with attributeDefNameUuid)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 usetypeOfGroup
- type of group can be an enum of TypeOfGroup, e.g. group, role, entity- Returns:
- the result of one member add
-
attributeDefNameSave
public WsAttributeDefNameSaveResults attributeDefNameSave(String clientVersion, WsAttributeDefNameToSave[] wsAttributeDefNameToSaves, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) save an AttributeDefName or many (insert or update). Note, you cannot rename an existing AttributeDefName.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeDefNameToSaves
- AttributeDefNames 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
-
attributeDefNameSaveLite
@POST @Path("/grouper-ws/servicesRest/vA_K_SAL/attributeDefNames") public WsAttributeDefNameSaveLiteResult attributeDefNameSaveLite(String clientVersion, String attributeDefNameLookupUuid, String attributeDefNameLookupName, String attributeDefLookupUuid, String attributeDefLookupName, String attributeDefNameUuid, String attributeDefNameName, String displayExtension, String description, String saveMode, String createParentStemsIfNotExist, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) save an AttributeDefName (insert or update). Note you cannot currently move an existing AttributeDefName.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000attributeDefNameLookupUuid
- the uuid of the attributeDefName to edit (mutually exclusive with attributeDefNameLookupName)attributeDefNameLookupName
- the name of the attributeDefName to edit (mutually exclusive with attributeDefNameLookupUuid)attributeDefLookupName
- to lookup the attributeDef (mutually exclusive with attributeDefUuid)attributeDefLookupUuid
- to lookup the attributeDef (mutually exclusive with attributeDefName)attributeDefNameName
- to lookup the attributeDefName (mutually exclusive with attributeDefNameUuid)attributeDefNameUuid
- to lookup the attributeDefName (mutually exclusive with attributeDefNameName)description
- of the attributeDefName, empty will be ignoreddisplayExtension
- display name of the attributeDefName, empty will be ignoredsaveMode
- if the save should be constrained to INSERT, UPDATE, or INSERT_OR_UPDATE (default)createParentStemsIfNotExist
- T or F (default F) if parent stems should be created if not existactAsSubjectId
- 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
-
findAttributeDefNames
public WsFindAttributeDefNamesResults findAttributeDefNames(String clientVersion, String scope, String splitScope, WsAttributeDefLookup wsAttributeDefLookup, String attributeAssignType, String attributeDefType, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, String pageSize, String pageNumber, String sortString, String ascending, String wsInheritanceSetRelation, WsSubjectLookup actAsSubjectLookup, WsParam[] params, WsSubjectLookup wsSubjectLookup, String serviceRole, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) find an attribute def name or attribute def names. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000scope
- search string with % as wildcards will search name, display name, descriptionsplitScope
- T or F, if T will split the scope by whitespace, and find attribute def names with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whateverwsAttributeDefLookup
- find names associated with this attribute definitionattributeAssignType
- where can the attribute definition be assigned, e.g. any_mem, any_mem_asgn, attr_def, attr_def_asgn, group, group_asgn, imm_mem, imm_mem_asgn, mem_asgn, member, stem, stem_asgnattributeDefType
- type of attribute definition, e.g. attr, domain, limit, perm, typeactAsSubjectLookup
- if searching as someone else, pass in that subject here, note the caller must be allowed to act as that other subjectparams
- optional: reserved for future usewsAttributeDefNameLookups
- if you want to just pass in a list of uuids and/or names.pageSize
- page size if paging on a sort filter or parentpageNumber
- page number 1 indexed if paging on a sort filter or parentsortString
- must be an hql query field, e.g. can sort on name, displayName, extension, displayExtensionascending
- or null for ascending, F for descending.pageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved itemwsInheritanceSetRelation
- if there is one wsAttributeDefNameLookup, and this is specified, then find the attribute def names which are related to the lookup by this relation, e.g. IMPLIED_BY_THIS, IMPLIED_BY_THIS_IMMEDIATE, THAT_IMPLY_THIS, THAT_IMPLY_THIS_IMMEDIATEwsSubjectLookup
- subject if looking for privileges or service roleserviceRole
- to filter attributes that a user has a certain role- Returns:
- the attribute def names, or no attribute def names if none found
-
findAttributeDefNamesLite
@POST @Path("/grouper-ws/servicesRest/vF_A_DNL/attributeDefNames") public WsFindAttributeDefNamesResults findAttributeDefNamesLite(String clientVersion, String scope, String splitScope, String uuidOfAttributeDef, String nameOfAttributeDef, String attributeAssignType, String attributeDefType, String attributeDefNameUuid, String attributeDefNameName, String pageSize, String pageNumber, String sortString, String ascending, String wsInheritanceSetRelation, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, String subjectId, String subjectSourceId, String subjectIdentifier, String serviceRole, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved) find an attribute def name or attribute def names. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000scope
- search string with % as wildcards will search name, display name, descriptionsplitScope
- T or F, if T will split the scope by whitespace, and find attribute def names with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whateveruuidOfAttributeDef
- find names associated with this attribute definition, mutually exclusive with nameOfAttributeDefnameOfAttributeDef
- find names associated with this attribute definition, mutually exclusive with idOfAttributeDefwsAttributeDefLookup
- find names associated with this attribute definitionattributeAssignType
- where can the attribute definition be assigned, e.g. any_mem, any_mem_asgn, attr_def, attr_def_asgn, group, group_asgn, imm_mem, imm_mem_asgn, mem_asgn, member, stem, stem_asgnattributeDefType
- type of attribute definition, e.g. attr, domain, limit, perm, typeattributeDefNameUuid
- to lookup an attribute def name by id, mutually exclusive with attributeDefNameNameattributeDefNameName
- to lookup an attribute def name by name, mutually exclusive with attributeDefNameIdpageSize
- page size if paging on a sort filter or parentpageNumber
- page number 1 indexed if paging on a sort filter or parentsortString
- must be an hql query field, e.g. can sort on name, displayName, extension, displayExtensionascending
- or null for ascending, F for descending.pageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved itemwsInheritanceSetRelation
- if there is one wsAttributeDefNameLookup, and this is specified, then find the attribute def names which are related to the lookup by this relation, e.g. IMPLIED_BY_THIS, IMPLIED_BY_THIS_IMMEDIATE, THAT_IMPLY_THIS, THAT_IMPLY_THIS_IMMEDIATEactAsSubjectId
- 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 usesubjectId
- subject id if looking for privileges or service rolesubjectSourceId
- subject source id if looking for privileges or service rolesubjectIdentifier
- subject identifier if looking for privileges or service roleserviceRole
- to filter attributes that a user has a certain role- Returns:
- the attribute def names, or no attribute def names if none found
-
sendMessage
public WsMessageResults sendMessage(String clientVersion, String queueType, String queueOrTopicName, String messageSystemName, String routingKey, String exchangeType, Map<String, Object> queueArguments, String autocreateObjects, WsMessage[] messages, WsSubjectLookup actAsSubjectLookup, WsParam[] params) - Parameters:
clientVersion
-queueType
- - queue or topic (required)queueOrTopicName
-messageSystemName
-routingKey
-exchangeType
-queueArguments
-autocreateObjects
-messages
-actAsSubjectLookup
-params
-- Returns:
- the results of message send call
-
receiveMessage
public WsMessageResults receiveMessage(String clientVersion, String queueType, String queueOrTopicName, String messageSystemName, String routingKey, String exchangeType, Map<String, Object> queueArguments, String autocreateObjects, String blockMillis, String maxMessagesToReceiveAtOnce, WsSubjectLookup actAsSubjectLookup, WsParam[] params) - Parameters:
clientVersion
-queueOrTopicName
-messageSystemName
-routingKey
-queueArguments
-autocreateObjects
-blockMillis
- - the millis to block waiting for messages, max of 20000 (optional)maxMessagesToReceiveAtOnce
- - max number of messages to receive at once, though can't be more than the server maximum (optional)actAsSubjectLookup
-params
-- Returns:
- the results of message receive call
-
acknowledge
public WsMessageAcknowledgeResults acknowledge(String clientVersion, String queueOrTopicName, String messageSystemName, String acknowledgeType, String[] messageIds, String anotherQueueOrTopicName, String anotherQueueType, WsSubjectLookup actAsSubjectLookup, WsParam[] params) - Parameters:
clientVersion
-queueOrTopicName
-messageSystemName
-acknowledgeType
- specify what to do with the messages (required)messageIds
- - messageIds to be marked as processed (required)anotherQueueOrTopicName
- - required if acknowledgeType is SEND_TO_ANOTHER_TOPIC_OR_QUEUEanotherQueueType
- - required if acknowledgeType is SEND_TO_ANOTHER_TOPIC_OR_QUEUEactAsSubjectLookup
-params
-- Returns:
- the results of message receive call
-
externalSubjectDelete
public WsExternalSubjectDeleteResults externalSubjectDelete(String clientVersion, WsExternalSubjectLookup[] wsExternalSubjectLookups, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) delete an external subject or many (if doesnt exist, ignore)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsExternalSubjectLookups
- 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.params
- optional: reserved for future use- Returns:
- the results
-
externalSubjectSave
public WsExternalSubjectSaveResults externalSubjectSave(String clientVersion, WsExternalSubjectToSave[] wsExternalSubjectToSaves, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params) save an external subject (insert or update).- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsExternalSubjectToSaves
- external subjects 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
- Since:
- 2.3.0.patch
-
findExternalSubjects
public WsFindExternalSubjectsResults findExternalSubjects(String clientVersion, WsExternalSubjectLookup[] wsExternalSubjectLookups, WsSubjectLookup actAsSubjectLookup, WsParam[] params) find a external subjects- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000actAsSubjectLookup
-params
- optional: reserved for future usewsExternalSubjectLookups
- if you want to just pass in a list of uuids and/or names- Returns:
- the external subjects, or no external subjects if none found
-
getAuditEntriesLite
@POST @Path("/grouper-ws/servicesRest/vG_E_AEL/audits") public WsGetAuditEntriesResults getAuditEntriesLite(String clientVersion, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String auditType, String auditActionId, String wsGroupName, String wsGroupId, String wsStemName, String wsStemId, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String wsSubjectId, String wsSubjectSourceId, String wsSubjectIdentifier, String actionsPerformedByWsSubjectId, String actionsPerformedByWsSubjectSourceId, String actionsPerformedByWsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, String pageSize, String sortString, String ascending, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String pointInTimeFrom, String pointInTimeTo) get audit entries- Parameters:
clientVersion
-actAsSubjectId
-actAsSubjectSourceId
-actAsSubjectIdentifier
-auditType
-auditActionId
-wsGroupName
-wsGroupId
-wsStemName
-wsStemId
-wsAttributeDefName
-wsAttributeDefId
-wsAttributeDefNameName
-wsAttributeDefNameId
-wsSubjectId
-wsSubjectSourceId
-wsSubjectIdentifier
-actionsPerformedByWsSubjectId
-actionsPerformedByWsSubjectSourceId
-actionsPerformedByWsSubjectIdentifier
-paramName0
-paramValue0
-paramName1
-paramValue1
-pageSize
-sortString
-ascending
-pageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved itempointInTimeFrom
-pointInTimeTo
-- Returns:
- audit entries result
-
getAuditEntries
public WsGetAuditEntriesResults getAuditEntries(String clientVersion, WsSubjectLookup actAsSubjectLookup, String auditType, String auditActionId, WsGroupLookup wsGroupLookup, WsStemLookup wsStemLookup, WsAttributeDefLookup wsAttributeDefLookup, WsAttributeDefNameLookup wsAttributeDefNameLookup, WsSubjectLookup wsSubjectLookup, WsSubjectLookup actionsPerformedByWsSubjectLookup, WsParam[] params, String pageSize, String sortString, String ascending, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String fromDate, String toDate) get audit entries- Parameters:
clientVersion
-actAsSubjectLookup
-auditType
-auditActionId
-wsGroupLookup
-wsStemLookup
-wsAttributeDefLookup
-wsAttributeDefNameLookup
-wsSubjectLookup
-actionsPerformedByWsSubjectLookup
-wsOwnerGroupLookups
-wsOwnerStemLookups
-wsOwnerAttributeDefLookups
-wsOwnerAttributeDefNameLookups
-wsOwnerSubjectLookups
-params
-pageSize
-sortString
-ascending
-pageIsCursor
- true means cursor based pagingpageLastCursorField
- field based on which paging needs to occurpageLastCursorFieldType
- type of last cursor field (eg: string, int, timestamp, etc)pageCursorFieldIncludesLastRetrieved
- should the result has last retrieved itemfromDate
-toDate
-- Returns:
- get audit entries
-