public class GrouperServiceLogic extends Object
| Constructor and Description |
|---|
GrouperServiceLogic() |
| Modifier and Type | Method and Description |
|---|---|
static WsMessageAcknowledgeResults |
acknowledge(GrouperVersion clientVersion,
String queueOrTopicName,
String messageSystemName,
edu.internet2.middleware.grouperClient.messaging.GrouperMessageAcknowledgeType acknowledgeType,
String[] messageIds,
String anotherQueueOrTopicName,
edu.internet2.middleware.grouperClient.messaging.GrouperMessageQueueType anotherQueueType,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params) |
static WsAddMemberResults |
addMember(GrouperVersion clientVersion,
WsGroupLookup wsGroupLookup,
WsSubjectLookup[] subjectLookups,
boolean replaceAllExisting,
WsSubjectLookup actAsSubjectLookup,
Field fieldName,
GrouperTransactionType txType,
boolean includeGroupDetail,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
WsParam[] params,
Timestamp disabledTime,
Timestamp enabledTime,
boolean addExternalSubjectIfNotFound)
add member to a group (if already a direct member, ignore)
|
static WsAddMemberLiteResult |
addMemberLite(GrouperVersion clientVersion,
String groupName,
String groupUuid,
String subjectId,
String subjectSourceId,
String subjectIdentifier,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
Field fieldName,
boolean includeGroupDetail,
boolean includeSubjectDetail,
String subjectAttributeNames,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
Timestamp disabledTime,
Timestamp enabledTime,
boolean addExternalSubjectIfNotFound)
add member to a group (if already a direct member, ignore)
|
static WsAttributeDefAssignActionResults |
assignAttributeDefActions(GrouperVersion clientVersion,
WsAttributeDefLookup wsAttributeDefLookup,
String[] actions,
boolean assign,
Boolean replaceAllExisting,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params)
add/remove/replace actions from Attribute Defs
|
static WsAssignAttributeDefNameInheritanceResults |
assignAttributeDefNameInheritance(GrouperVersion clientVersion,
WsAttributeDefNameLookup wsAttributeDefNameLookup,
WsAttributeDefNameLookup[] relatedWsAttributeDefNameLookups,
boolean assign,
Boolean replaceAllExisting,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
WsParam[] params)
assign or unassign attribute def name permission inheritance
|
static WsAssignAttributeDefNameInheritanceResults |
assignAttributeDefNameInheritanceLite(GrouperVersion clientVersion,
String attributeDefNameUuid,
String attributeDefNameName,
String relatedAttributeDefNameUuid,
String relatedAttributeDefNameName,
boolean assign,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
assign or unassign attribute def name permission inheritance
|
static WsAssignAttributesResults |
assignAttributes(GrouperVersion clientVersion,
AttributeAssignType attributeAssignType,
WsAttributeDefNameLookup[] wsAttributeDefNameLookups,
AttributeAssignOperation attributeAssignOperation,
WsAttributeAssignValue[] values,
String assignmentNotes,
Timestamp assignmentEnabledTime,
Timestamp assignmentDisabledTime,
AttributeAssignDelegatable delegatable,
AttributeAssignValueOperation attributeAssignValueOperation,
WsAttributeAssignLookup[] wsAttributeAssignLookups,
WsGroupLookup[] wsOwnerGroupLookups,
WsStemLookup[] wsOwnerStemLookups,
WsSubjectLookup[] wsOwnerSubjectLookups,
WsMembershipLookup[] wsOwnerMembershipLookups,
WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups,
WsAttributeDefLookup[] wsOwnerAttributeDefLookups,
WsAttributeAssignLookup[] wsOwnerAttributeAssignLookups,
String[] actions,
WsSubjectLookup actAsSubjectLookup,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
boolean includeGroupDetail,
WsParam[] params,
WsAttributeDefLookup[] attributeDefsToReplace,
String[] actionsToReplace,
String[] attributeDefTypesToReplace)
assign attributes and values to owner objects (groups, stems, etc)
|
static WsAssignAttributesBatchResults |
assignAttributesBatch(GrouperVersion clientVersion,
WsAssignAttributeBatchEntry[] wsAssignAttributeBatchEntries,
WsSubjectLookup actAsSubjectLookup,
boolean includeSubjectDetail,
GrouperTransactionType txType,
String[] subjectAttributeNames,
boolean includeGroupDetail,
WsParam[] params)
assign attributes and values to owner objects (groups, stems, etc), doing multiple operations in one batch
|
static WsAssignAttributesLiteResults |
assignAttributesLite(GrouperVersion clientVersion,
AttributeAssignType attributeAssignType,
String wsAttributeDefNameName,
String wsAttributeDefNameId,
AttributeAssignOperation attributeAssignOperation,
String valueId,
String valueSystem,
String valueFormatted,
String assignmentNotes,
Timestamp assignmentEnabledTime,
Timestamp assignmentDisabledTime,
AttributeAssignDelegatable delegatable,
AttributeAssignValueOperation 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,
boolean includeSubjectDetail,
String subjectAttributeNames,
boolean includeGroupDetail,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
assign attributes and values to owner objects (groups, stems, etc)
|
static WsAssignGrouperPrivilegesResults |
assignGrouperPrivileges(GrouperVersion clientVersion,
WsSubjectLookup[] wsSubjectLookups,
WsGroupLookup wsGroupLookup,
WsStemLookup wsStemLookup,
PrivilegeType privilegeType,
Privilege[] privilegeNames,
boolean allowed,
boolean replaceAllExisting,
GrouperTransactionType txType,
WsSubjectLookup actAsSubjectLookup,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
boolean includeGroupDetail,
WsParam[] params)
assign a privilege for a user/group/type/name combo
e.g.
|
static WsAssignGrouperPrivilegesLiteResult |
assignGrouperPrivilegesLite(GrouperVersion clientVersion,
String subjectId,
String subjectSourceId,
String subjectIdentifier,
String groupName,
String groupUuid,
String stemName,
String stemUuid,
PrivilegeType privilegeType,
Privilege privilegeName,
boolean allowed,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
boolean includeSubjectDetail,
String subjectAttributeNames,
boolean includeGroupDetail,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
assign a privilege for a user/group/type/name combo
e.g.
|
static WsAssignPermissionsResults |
assignPermissions(GrouperVersion clientVersion,
PermissionEntry.PermissionType permissionType,
WsAttributeDefNameLookup[] permissionDefNameLookups,
PermissionAssignOperation permissionAssignOperation,
String assignmentNotes,
Timestamp assignmentEnabledTime,
Timestamp assignmentDisabledTime,
AttributeAssignDelegatable delegatable,
WsAttributeAssignLookup[] wsAttributeAssignLookups,
WsGroupLookup[] roleLookups,
WsMembershipAnyLookup[] subjectRoleLookups,
String[] actions,
WsSubjectLookup actAsSubjectLookup,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
boolean includeGroupDetail,
WsParam[] params,
WsAttributeDefLookup[] attributeDefsToReplace,
String[] actionsToReplace,
Boolean disallowed)
assign permissions to roles or subjects (in the context of a role)
|
static WsAssignPermissionsLiteResults |
assignPermissionsLite(GrouperVersion clientVersion,
PermissionEntry.PermissionType permissionType,
String permissionDefNameName,
String permissionDefNameId,
PermissionAssignOperation permissionAssignOperation,
String assignmentNotes,
Timestamp assignmentEnabledTime,
Timestamp assignmentDisabledTime,
AttributeAssignDelegatable 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,
boolean includeSubjectDetail,
String subjectAttributeNames,
boolean includeGroupDetail,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
Boolean disallowed)
assign permissions to role or subject (in the context of a role)
|
static WsAttributeDefDeleteResults |
attributeDefDelete(GrouperVersion clientVersion,
WsAttributeDefLookup[] wsAttributeDefLookups,
GrouperTransactionType txType,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params)
delete attribute defs
|
static WsAttributeDefDeleteLiteResult |
attributeDefDeleteLite(GrouperVersion clientVersion,
String wsNameOfAttributeDef,
String wsIdOfAttributeDef,
String wsIdIndexOfAttributeDef,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
remove attribute definition based on name, id or uuid
|
static WsAttributeDefNameDeleteResults |
attributeDefNameDelete(GrouperVersion clientVersion,
WsAttributeDefNameLookup[] wsAttributeDefNameLookups,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
WsParam[] params)
delete an AttributeDefName or many.
|
static WsAttributeDefNameDeleteLiteResult |
attributeDefNameDeleteLite(GrouperVersion clientVersion,
String attributeDefNameUuid,
String attributeDefNameName,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
delete an AttributeDefName
|
static WsAttributeDefNameSaveResults |
attributeDefNameSave(GrouperVersion clientVersion,
WsAttributeDefNameToSave[] wsAttributeDefNameToSaves,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
WsParam[] params)
save an AttributeDefName or many (insert or update).
|
static WsAttributeDefNameSaveLiteResult |
attributeDefNameSaveLite(GrouperVersion clientVersion,
String attributeDefNameLookupUuid,
String attributeDefNameLookupName,
String attributeDefLookupUuid,
String attributeDefLookupName,
String attributeDefNameUuid,
String attributeDefNameName,
String displayExtension,
String description,
SaveMode saveMode,
Boolean createParentStemsIfNotExist,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
save an AttributeDefName (insert or update).
|
static WsAttributeDefSaveResults |
attributeDefSave(GrouperVersion clientVersion,
WsAttributeDefToSave[] wsAttributeDefsToSave,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
WsParam[] params)
save an AttributeDef or many (insert or update).
|
static WsAttributeDefSaveLiteResult |
attributeDefSaveLite(GrouperVersion clientVersion,
String attributeDefLookupUuid,
String attributeDefLookupName,
String uuidOfAttributeDef,
String nameOfAttributeDef,
Boolean assignToAttributeDef,
Boolean assignToAttributeDefAssignment,
Boolean assignToEffectiveMembership,
Boolean assignToEffectiveMembershipAssignment,
Boolean assignToGroup,
Boolean assignToGroupAssignment,
Boolean assignToImmediateMembership,
Boolean assignToImmediateMembershipAssignment,
Boolean assignToMember,
Boolean assignToMemberAssignment,
Boolean assignToStem,
Boolean assignToStemAssignment,
String attributeDefType,
String multiAssignable,
String multiValued,
String valueType,
String description,
SaveMode saveMode,
Boolean createParentStemsIfNotExist,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
save an AttributeDef (insert or update).
|
static WsDeleteMemberResults |
deleteMember(GrouperVersion clientVersion,
WsGroupLookup wsGroupLookup,
WsSubjectLookup[] subjectLookups,
WsSubjectLookup actAsSubjectLookup,
Field fieldName,
GrouperTransactionType txType,
boolean includeGroupDetail,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
WsParam[] params)
remove member(s) from a group (if not already a direct member, ignore)
|
static WsDeleteMemberLiteResult |
deleteMemberLite(GrouperVersion clientVersion,
String groupName,
String groupUuid,
String subjectId,
String subjectSourceId,
String subjectIdentifier,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
Field fieldName,
boolean includeGroupDetail,
boolean includeSubjectDetail,
String subjectAttributeNames,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
delete member to a group (if not already a direct member, ignore)
|
static WsGshTemplateExecResult |
executeGshTemplate(GrouperVersion clientVersion,
String configId,
GshTemplateOwnerType ownerType,
WsGroupLookup ownerGroupLookup,
WsStemLookup ownerStemLookup,
WsGshTemplateInput[] inputs,
WsSubjectLookup gshTemplateActAsSubjectLookup,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params)
execute gsh template
|
static WsExternalSubjectDeleteResults |
externalSubjectDelete(GrouperVersion clientVersion,
WsExternalSubjectLookup[] wsExternalSubjectLookups,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
WsParam[] params)
delete an external subject or many (if doesnt exist, ignore)
|
static WsExternalSubjectSaveResults |
externalSubjectSave(GrouperVersion clientVersion,
WsExternalSubjectToSave[] wsExternalSubjectToSaves,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
WsParam[] params)
save an external subject (insert or update).
|
static WsFindAttributeDefNamesResults |
findAttributeDefNames(GrouperVersion clientVersion,
String scope,
Boolean splitScope,
WsAttributeDefLookup wsAttributeDefLookup,
AttributeAssignType attributeAssignType,
AttributeDefType attributeDefType,
WsAttributeDefNameLookup[] wsAttributeDefNameLookups,
Integer pageSize,
Integer pageNumber,
String sortString,
Boolean ascending,
WsInheritanceSetRelation wsInheritanceSetRelation,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params,
WsSubjectLookup wsSubjectLookup,
ServiceRole serviceRole,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved)
find an attribute def name or attribute def names.
|
static WsFindAttributeDefNamesResults |
findAttributeDefNamesLite(GrouperVersion clientVersion,
String scope,
Boolean splitScope,
String uuidOfAttributeDef,
String nameOfAttributeDef,
AttributeAssignType attributeAssignType,
AttributeDefType attributeDefType,
String attributeDefNameUuid,
String attributeDefNameName,
Integer pageSize,
Integer pageNumber,
String sortString,
Boolean ascending,
WsInheritanceSetRelation wsInheritanceSetRelation,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
String subjectId,
String subjectSourceId,
String subjectIdentifier,
ServiceRole serviceRole,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved)
find an attribute def name or attribute def names.
|
static WsFindAttributeDefsResults |
findAttributeDefs(GrouperVersion clientVersion,
String scope,
Boolean splitScope,
WsAttributeDefLookup[] wsAttributeDefLookups,
String privilegeName,
StemScope stemScope,
String parentStemId,
Boolean findByUuidOrName,
Integer pageSize,
Integer pageNumber,
String sortString,
Boolean ascending,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved)
find an attribute def or attribute defs.
|
static WsFindAttributeDefsResults |
findAttributeDefsLite(GrouperVersion clientVersion,
String scope,
Boolean splitScope,
String uuidOfAttributeDef,
String nameOfAttributeDef,
String idIndexOfAttributeDef,
String privilegeName,
StemScope stemScope,
String parentStemId,
Boolean findByUuidOrName,
Integer pageSize,
Integer pageNumber,
String sortString,
Boolean ascending,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved)
find an attribute def name attribute defs.
|
static WsFindExternalSubjectsResults |
findExternalSubjects(GrouperVersion clientVersion,
WsExternalSubjectLookup[] wsExternalSubjectLookups,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params)
find a external subjects
|
static WsFindGroupsResults |
findGroups(GrouperVersion clientVersion,
WsQueryFilter wsQueryFilter,
WsSubjectLookup actAsSubjectLookup,
boolean includeGroupDetail,
WsParam[] params,
WsGroupLookup[] wsGroupLookups)
find a group or groups
|
static WsFindGroupsResults |
findGroupsLite(GrouperVersion clientVersion,
WsQueryFilterType queryFilterType,
String groupName,
String stemName,
StemScope stemNameScope,
String groupUuid,
String groupAttributeName,
String groupAttributeValue,
GroupType groupTypeName,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
boolean 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
|
static WsFindStemsResults |
findStems(GrouperVersion clientVersion,
WsStemQueryFilter wsStemQueryFilter,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params,
WsStemLookup[] wsStemLookups)
find a stem or stems
|
static WsFindStemsResults |
findStemsLite(GrouperVersion clientVersion,
WsStemQueryFilterType stemQueryFilterType,
String stemName,
String parentStemName,
StemScope 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
|
static WsGetAttributeAssignActionsResults |
getAttributeAssignActions(GrouperVersion clientVersion,
WsAttributeDefLookup[] wsAttributeDefLookups,
String[] actions,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params)
get attributeAssignActions from attribute definitions, actions, etc
|
static WsGetAttributeAssignActionsResults |
getAttributeAssignActionsLite(GrouperVersion clientVersion,
String wsNameOfAttributeDef,
String wsIdOfAttributeDef,
String wsIdIndexOfAttributeDef,
String action,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
get attributeAssignActions from attribute definition
|
static WsGetAttributeAssignmentsResults |
getAttributeAssignments(GrouperVersion clientVersion,
AttributeAssignType attributeAssignType,
WsAttributeAssignLookup[] wsAttributeAssignLookups,
WsAttributeDefLookup[] wsAttributeDefLookups,
WsAttributeDefNameLookup[] wsAttributeDefNameLookups,
WsGroupLookup[] wsOwnerGroupLookups,
WsStemLookup[] wsOwnerStemLookups,
WsSubjectLookup[] wsOwnerSubjectLookups,
WsMembershipLookup[] wsOwnerMembershipLookups,
WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups,
WsAttributeDefLookup[] wsOwnerAttributeDefLookups,
String[] actions,
boolean includeAssignmentsOnAssignments,
WsSubjectLookup actAsSubjectLookup,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
boolean includeGroupDetail,
WsParam[] params,
String enabled,
AttributeDefValueType attributeDefValueType,
Object theValue,
boolean includeAssignmentsFromAssignments,
AttributeDefType attributeDefType,
WsAttributeAssignLookup[] wsAssignAssignOwnerAttributeAssignLookups,
WsAttributeDefLookup[] wsAssignAssignOwnerAttributeDefLookups,
WsAttributeDefNameLookup[] wsAssignAssignOwnerAttributeDefNameLookups,
String[] wsAssignAssignOwnerActions)
get attributeAssignments from groups etc based on inputs
|
static WsGetAttributeAssignmentsResults |
getAttributeAssignmentsLite(GrouperVersion clientVersion,
AttributeAssignType 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,
boolean includeAssignmentsOnAssignments,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
boolean includeSubjectDetail,
String subjectAttributeNames,
boolean includeGroupDetail,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
String enabled,
AttributeDefValueType attributeDefValueType,
Object theValue,
boolean includeAssignmentsFromAssignments,
AttributeDefType attributeDefType,
String wsAssignAssignOwnerAttributeAssignId,
String wsAssignAssignOwnerIdOfAttributeDef,
String wsAssignAssignOwnerNameOfAttributeDef,
String wsAssignAssignOwnerIdOfAttributeDefName,
String wsAssignAssignOwnerNameOfAttributeDefName,
String wsAssignAssignOwnerAction)
get attributeAssignments from group and or subject based on inputs
|
static WsGetAuditEntriesResults |
getAuditEntries(GrouperVersion clientVersion,
WsSubjectLookup actAsSubjectLookup,
String auditType,
String auditActionId,
WsGroupLookup wsGroupLookup,
WsStemLookup wsStemLookup,
WsAttributeDefLookup wsAttributeDefLookup,
WsAttributeDefNameLookup wsAttributeDefNameLookup,
WsSubjectLookup wsSubjectLookup,
WsSubjectLookup actionsPerformedByWsSubjectLookup,
WsParam[] params,
Integer pageSize,
String sortString,
Boolean ascending,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved,
Timestamp fromDate,
Timestamp toDate)
get audit entries
|
static WsGetAuditEntriesResults |
getAuditEntriesLite(GrouperVersion 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,
Integer pageSize,
String sortString,
Boolean ascending,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved,
Timestamp fromDate,
Timestamp toDate)
get audit entries
|
static WsGetGrouperPrivilegesLiteResult |
getGrouperPrivilegesLite(GrouperVersion clientVersion,
String subjectId,
String subjectSourceId,
String subjectIdentifier,
String groupName,
String groupUuid,
String stemName,
String stemUuid,
PrivilegeType privilegeType,
Privilege privilegeName,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
boolean includeSubjectDetail,
String subjectAttributeNames,
boolean includeGroupDetail,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
get grouper privileges for a group or folder
e.g.
|
static WsGetGroupsResults |
getGroups(GrouperVersion clientVersion,
WsSubjectLookup[] subjectLookups,
WsMemberFilter memberFilter,
WsSubjectLookup actAsSubjectLookup,
boolean includeGroupDetail,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
WsParam[] params,
String fieldName,
String scope,
WsStemLookup wsStemLookup,
StemScope stemScope,
String enabled,
Integer pageSize,
Integer pageNumber,
String sortString,
Boolean ascending,
Timestamp pointInTimeFrom,
Timestamp pointInTimeTo,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved)
get groups from members based on filter (accepts batch of members)
|
static WsGetGroupsLiteResult |
getGroupsLite(GrouperVersion clientVersion,
String subjectId,
String subjectSourceId,
String subjectIdentifier,
WsMemberFilter memberFilter,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
boolean includeGroupDetail,
boolean includeSubjectDetail,
String subjectAttributeNames,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
String fieldName,
String scope,
String stemName,
String stemUuid,
StemScope stemScope,
String enabled,
Integer pageSize,
Integer pageNumber,
String sortString,
Boolean ascending,
Timestamp pointInTimeFrom,
Timestamp pointInTimeTo,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved)
get groups for a subject based on filter
|
static WsGetMembersResults |
getMembers(GrouperVersion clientVersion,
WsGroupLookup[] wsGroupLookups,
WsMemberFilter memberFilter,
WsSubjectLookup actAsSubjectLookup,
Field fieldName,
boolean includeGroupDetail,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
WsParam[] params,
String[] sourceIds,
Timestamp pointInTimeFrom,
Timestamp pointInTimeTo,
Integer pageSize,
Integer pageNumber,
String sortString,
Boolean ascending,
Boolean pointInTimeRetrieve,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved)
get members from a group based on a filter (all, immediate only,
effective only, composite)
|
static WsGetMembershipsResults |
getMemberships(GrouperVersion clientVersion,
WsGroupLookup[] wsGroupLookups,
WsSubjectLookup[] wsSubjectLookups,
WsMemberFilter wsMemberFilter,
WsSubjectLookup actAsSubjectLookup,
Field fieldName,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
boolean includeGroupDetail,
WsParam[] params,
String[] sourceIds,
String scope,
WsStemLookup wsStemLookup,
StemScope stemScope,
String enabled,
String[] membershipIds,
WsStemLookup[] wsOwnerStemLookups,
WsAttributeDefLookup[] wsOwnerAttributeDefLookups,
FieldType fieldType,
ServiceRole serviceRole,
WsAttributeDefNameLookup serviceLookup,
Integer pageSize,
Integer pageNumber,
String sortString,
Boolean ascending,
Integer pageSizeForMember,
Integer pageNumberForMember,
String sortStringForMember,
Boolean ascendingForMember,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved,
Boolean pageIsCursorForMember,
String pageLastCursorFieldForMember,
String pageLastCursorFieldTypeForMember,
Boolean pageCursorFieldIncludesLastRetrievedForMember,
Boolean pointInTimeRetrieve,
Timestamp pointInTimeFrom,
Timestamp pointInTimeTo)
get memberships from groups and or subjects based on a filter (all, immediate only,
effective only, composite, nonimmediate).
|
static WsGetMembershipsResults |
getMembershipsLite(GrouperVersion clientVersion,
String groupName,
String groupUuid,
String subjectId,
String sourceId,
String subjectIdentifier,
WsMemberFilter wsMemberFilter,
boolean includeSubjectDetail,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
Field fieldName,
String subjectAttributeNames,
boolean includeGroupDetail,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
String sourceIds,
String scope,
String stemName,
String stemUuid,
StemScope stemScope,
String enabled,
String membershipIds,
String ownerStemName,
String ownerStemUuid,
String nameOfOwnerAttributeDef,
String ownerAttributeDefUuid,
FieldType fieldType,
ServiceRole serviceRole,
String serviceId,
String serviceName,
Integer pageSize,
Integer pageNumber,
String sortString,
Boolean ascending,
Integer pageSizeForMember,
Integer pageNumberForMember,
String sortStringForMember,
Boolean ascendingForMember,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved,
Boolean pageIsCursorForMember,
String pageLastCursorFieldForMember,
String pageLastCursorFieldTypeForMember,
Boolean pageCursorFieldIncludesLastRetrievedForMember,
Boolean pointInTimeRetrieve,
Timestamp pointInTimeFrom,
Timestamp pointInTimeTo)
get memberships from a group based on a filter (all, immediate only,
effective only, composite)
|
static WsGetMembersLiteResult |
getMembersLite(GrouperVersion clientVersion,
String groupName,
String groupUuid,
WsMemberFilter memberFilter,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
Field fieldName,
boolean includeGroupDetail,
boolean includeSubjectDetail,
String subjectAttributeNames,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
String sourceIds,
Timestamp pointInTimeFrom,
Timestamp pointInTimeTo,
Integer pageSize,
Integer pageNumber,
String sortString,
Boolean ascending,
Boolean pointInTimeRetrieve,
Boolean pageIsCursor,
String pageLastCursorField,
String pageLastCursorFieldType,
Boolean pageCursorFieldIncludesLastRetrieved)
get members from a group based on a filter (all, immediate only,
effective only, composite)
|
static WsGetPermissionAssignmentsResults |
getPermissionAssignments(GrouperVersion clientVersion,
WsAttributeDefLookup[] wsAttributeDefLookups,
WsAttributeDefNameLookup[] wsAttributeDefNameLookups,
WsGroupLookup[] roleLookups,
WsSubjectLookup[] wsSubjectLookups,
String[] actions,
boolean includePermissionAssignDetail,
boolean includeAttributeDefNames,
boolean includeAttributeAssignments,
boolean includeAssignmentsOnAssignments,
WsSubjectLookup actAsSubjectLookup,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
boolean includeGroupDetail,
WsParam[] params,
String enabled,
Timestamp pointInTimeFrom,
Timestamp pointInTimeTo,
boolean immediateOnly,
PermissionEntry.PermissionType permissionType,
PermissionProcessor permissionProcessor,
WsPermissionEnvVar[] limitEnvVars,
boolean includeLimits)
get permissionAssignments from roles etc based on inputs
|
static WsGetPermissionAssignmentsResults |
getPermissionAssignmentsLite(GrouperVersion clientVersion,
String wsAttributeDefName,
String wsAttributeDefId,
String wsAttributeDefNameName,
String wsAttributeDefNameId,
String roleName,
String roleId,
String wsSubjectId,
String wsSubjectSourceId,
String wsSubjectIdentifier,
String action,
boolean includePermissionAssignDetail,
boolean includeAttributeDefNames,
boolean includeAttributeAssignments,
boolean includeAssignmentsOnAssignments,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
boolean includeSubjectDetail,
String subjectAttributeNames,
boolean includeGroupDetail,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
String enabled,
Timestamp pointInTimeFrom,
Timestamp pointInTimeTo,
boolean immediateOnly,
PermissionEntry.PermissionType permissionType,
PermissionProcessor permissionProcessor,
String limitEnvVarName0,
String limitEnvVarValue0,
String limitEnvVarType0,
String limitEnvVarName1,
String limitEnvVarValue1,
String limitEnvVarType1,
boolean includeLimits)
get permissionAssignments from role etc based on inputs
|
static WsGetSubjectsResults |
getSubjects(GrouperVersion clientVersion,
WsSubjectLookup[] wsSubjectLookups,
String searchString,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
WsSubjectLookup actAsSubjectLookup,
String[] sourceIds,
WsGroupLookup wsGroupLookup,
WsMemberFilter wsMemberFilter,
Field fieldName,
boolean includeGroupDetail,
WsParam[] params)
get subjects from searching by id or identifier or search string.
|
static WsGetSubjectsResults |
getSubjectsLite(GrouperVersion clientVersion,
String subjectId,
String sourceId,
String subjectIdentifier,
String searchString,
boolean includeSubjectDetail,
String subjectAttributeNames,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
String sourceIds,
String groupName,
String groupUuid,
WsMemberFilter wsMemberFilter,
Field fieldName,
boolean includeGroupDetail,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
get subjects from searching by id or identifier or search string.
|
static WsGroupDeleteResults |
groupDelete(GrouperVersion clientVersion,
WsGroupLookup[] wsGroupLookups,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
boolean includeGroupDetail,
WsParam[] params)
delete a group or many (if doesnt exist, ignore)
|
static WsGroupDeleteLiteResult |
groupDeleteLite(GrouperVersion clientVersion,
String groupName,
String groupUuid,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
boolean includeGroupDetail,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
delete a group or many (if doesnt exist, ignore)
|
static WsGroupSaveResults |
groupSave(GrouperVersion clientVersion,
WsGroupToSave[] wsGroupToSaves,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
boolean includeGroupDetail,
WsParam[] params)
save a group or many (insert or update).
|
static WsGroupSaveLiteResult |
groupSaveLite(GrouperVersion clientVersion,
String groupLookupUuid,
String groupLookupName,
String groupUuid,
String groupName,
String displayExtension,
String description,
SaveMode saveMode,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
boolean includeGroupDetail,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
TypeOfGroup typeOfGroup,
String alternateName,
Timestamp disabledTime,
Timestamp enabledTime)
save a group (insert or update).
|
static WsHasMemberResults |
hasMember(GrouperVersion clientVersion,
WsGroupLookup wsGroupLookup,
WsSubjectLookup[] subjectLookups,
WsMemberFilter memberFilter,
WsSubjectLookup actAsSubjectLookup,
Field fieldName,
boolean includeGroupDetail,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
WsParam[] params,
Timestamp pointInTimeFrom,
Timestamp pointInTimeTo)
see if a group has members based on filter (accepts batch of members)
|
static WsHasMemberLiteResult |
hasMemberLite(GrouperVersion clientVersion,
String groupName,
String groupUuid,
String subjectId,
String subjectSourceId,
String subjectIdentifier,
WsMemberFilter memberFilter,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
Field fieldName,
boolean includeGroupDetail,
boolean includeSubjectDetail,
String subjectAttributeNames,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1,
Timestamp pointInTimeFrom,
Timestamp pointInTimeTo)
see if a group has a member (if already a direct member, ignore)
|
static WsMemberChangeSubjectResults |
memberChangeSubject(GrouperVersion clientVersion,
WsMemberChangeSubject[] wsMemberChangeSubjects,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
boolean includeSubjectDetail,
String[] subjectAttributeNames,
WsParam[] params)
change the subject in a member or some members
|
static WsMemberChangeSubjectLiteResult |
memberChangeSubjectLite(GrouperVersion clientVersion,
String oldSubjectId,
String oldSubjectSourceId,
String oldSubjectIdentifier,
String newSubjectId,
String newSubjectSourceId,
String newSubjectIdentifier,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
boolean deleteOldMember,
boolean includeSubjectDetail,
String subjectAttributeNames,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
see if a group has a member (if already a direct member, ignore)
|
static WsMessageResults |
receiveMessage(GrouperVersion clientVersion,
edu.internet2.middleware.grouperClient.messaging.GrouperMessageQueueType queueType,
String queueOrTopicName,
String messageSystemName,
String routingKey,
String exchangeType,
Map<String,Object> queueArguments,
Boolean autocreateObjects,
Integer blockMillis,
Integer maxMessagesToReceiveAtOnce,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params) |
static void |
removePrivsNotAllowedToSee(Set<GrouperPrivilege> privileges)
remove privileges not allowed to see
|
static void |
removePrivsNotAllowedToSee(TreeSet<GrouperPrivilege> privileges)
remove privileges not allowed to see
|
static WsMessageResults |
sendMessage(GrouperVersion clientVersion,
edu.internet2.middleware.grouperClient.messaging.GrouperMessageQueueType queueType,
String queueOrTopicName,
String messageSystemName,
String routingKey,
String exchangeType,
Map<String,Object> queueArguments,
Boolean autocreateObjects,
WsMessage[] messages,
WsSubjectLookup actAsSubjectLookup,
WsParam[] params) |
static WsStemDeleteResults |
stemDelete(GrouperVersion clientVersion,
WsStemLookup[] wsStemLookups,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
WsParam[] params)
delete a stem or many (if doesnt exist, ignore)
|
static WsStemDeleteLiteResult |
stemDeleteLite(GrouperVersion 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)
|
static WsStemSaveResults |
stemSave(GrouperVersion clientVersion,
WsStemToSave[] wsStemToSaves,
WsSubjectLookup actAsSubjectLookup,
GrouperTransactionType txType,
WsParam[] params)
save a stem or many (insert or update).
|
static WsStemSaveLiteResult |
stemSaveLite(GrouperVersion clientVersion,
String stemLookupUuid,
String stemLookupName,
String stemUuid,
String stemName,
String displayExtension,
String description,
SaveMode saveMode,
String actAsSubjectId,
String actAsSubjectSourceId,
String actAsSubjectIdentifier,
String paramName0,
String paramValue0,
String paramName1,
String paramValue1)
save a stem (insert or update).
|
public static WsAddMemberResults addMember(GrouperVersion clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, boolean replaceAllExisting, WsSubjectLookup actAsSubjectLookup, Field fieldName, GrouperTransactionType txType, boolean includeGroupDetail, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, Timestamp disabledTime, Timestamp enabledTime, boolean addExternalSubjectIfNotFound)
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). by fieldNametxType - 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 useincludeSubjectDetail - 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 sentdisabledTime - 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 allowedGrouperVersionpublic static WsAddMemberLiteResult addMemberLite(GrouperVersion clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, Timestamp disabledTime, Timestamp enabledTime, boolean addExternalSubjectIfNotFound)
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 allowedpublic static WsDeleteMemberResults deleteMember(GrouperVersion clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, WsSubjectLookup actAsSubjectLookup, Field fieldName, GrouperTransactionType txType, boolean includeGroupDetail, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params)
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 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 usepublic static WsDeleteMemberLiteResult deleteMemberLite(GrouperVersion clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1)
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 usepublic static WsFindGroupsResults findGroups(GrouperVersion clientVersion, WsQueryFilter wsQueryFilter, WsSubjectLookup actAsSubjectLookup, boolean includeGroupDetail, WsParam[] params, WsGroupLookup[] wsGroupLookups)
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 groups are returned
in alphabetical orderpublic static WsFindGroupsResults findGroupsLite(GrouperVersion clientVersion, WsQueryFilterType queryFilterType, String groupName, String stemName, StemScope stemNameScope, String groupUuid, String groupAttributeName, String groupAttributeValue, GroupType groupTypeName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean 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)
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 (context in query type)stemName - 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 comma separated TypeOfGroups to find, e.g. group, role, entityenabled - enabled is A for all, T or null for enabled only, F for disabledpublic static WsFindStemsResults findStems(GrouperVersion clientVersion, WsStemQueryFilter wsStemQueryFilter, WsSubjectLookup actAsSubjectLookup, WsParam[] params, WsStemLookup[] wsStemLookups)
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, etcactAsSubjectLookup - to act as a different user than the logged in userparams - optional: reserved for future usewsStemLookups - to pass in a list of uuids or names to lookup. Note the stems are returned
in alphabetical orderpublic static WsFindStemsResults findStemsLite(GrouperVersion clientVersion, WsStemQueryFilterType stemQueryFilterType, String stemName, String parentStemName, StemScope parentStemNameScope, String stemUuid, String stemAttributeName, String stemAttributeValue, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
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_EXACT, FIND_BY_PARENT_STEM_NAME,
FIND_BY_APPROXIMATE_ATTRIBUTE,
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 usepublic static WsGetGroupsResults getGroups(GrouperVersion clientVersion, WsSubjectLookup[] subjectLookups, WsMemberFilter memberFilter, WsSubjectLookup actAsSubjectLookup, boolean includeGroupDetail, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String fieldName, String scope, WsStemLookup wsStemLookup, StemScope stemScope, String enabled, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000subjectLookup - subjectLookups - 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 userincludeGroupDetail - T or F as to if the group detail should be
included (defaults to F)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 sentparams - 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 if in this stem, or in 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, 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.pointInTimeTo - 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.public static WsGetGroupsLiteResult getGroupsLite(GrouperVersion clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, WsMemberFilter memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeGroupDetail, boolean includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String fieldName, String scope, String stemName, String stemUuid, StemScope stemScope, String enabled, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
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
actAsSubjectIdentifersubjectIdentifier - 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)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 if in this stem, or in 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, 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.pointInTimeTo - 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.public static WsGetMembersResults getMembers(GrouperVersion clientVersion, WsGroupLookup[] wsGroupLookups, WsMemberFilter memberFilter, WsSubjectLookup actAsSubjectLookup, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String[] sourceIds, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Boolean pointInTimeRetrieve, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsGroupLookups - are groups to check members formemberFilter - 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 - are source ids of members to retrievepointInTimeRetrieve - true means pull point in time retrieve, false otherwisepointInTimeFrom - 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.pointInTimeTo - 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.pageSize - page size if pagingpageNumber - page number 1 indexed if pagingsortString - must be an hql query field, e.g.
can sort on uuid, subjectId, sourceId, sourceString0, sortString1, sortString2, sortString3, sortString4, name, descriptionascending - 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 itempublic static WsGetMembershipsResults getMemberships(GrouperVersion clientVersion, WsGroupLookup[] wsGroupLookups, WsSubjectLookup[] wsSubjectLookups, WsMemberFilter wsMemberFilter, WsSubjectLookup actAsSubjectLookup, Field fieldName, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params, String[] sourceIds, String scope, WsStemLookup wsStemLookup, StemScope stemScope, String enabled, String[] membershipIds, WsStemLookup[] wsOwnerStemLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, FieldType fieldType, ServiceRole serviceRole, WsAttributeDefNameLookup serviceLookup, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Integer pageSizeForMember, Integer pageNumberForMember, String sortStringForMember, Boolean ascendingForMember, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved, Boolean pageIsCursorForMember, String pageLastCursorFieldForMember, String pageLastCursorFieldTypeForMember, Boolean pageCursorFieldIncludesLastRetrievedForMember, Boolean pointInTimeRetrieve, Timestamp pointInTimeFrom, Timestamp pointInTimeTo)
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 - stem lookups if looking for memberships on certain stemswsOwnerAttributeDefLookups - attribute definition lookups if looking for memberships on certain attribute definitionsfieldType - 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 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.pointInTimeTo - 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.public static WsGetMembershipsResults getMembershipsLite(GrouperVersion clientVersion, String groupName, String groupUuid, String subjectId, String sourceId, String subjectIdentifier, WsMemberFilter wsMemberFilter, boolean includeSubjectDetail, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, Field fieldName, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String sourceIds, String scope, String stemName, String stemUuid, StemScope stemScope, String enabled, String membershipIds, String ownerStemName, String ownerStemUuid, String nameOfOwnerAttributeDef, String ownerAttributeDefUuid, FieldType fieldType, ServiceRole serviceRole, String serviceId, String serviceName, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Integer pageSizeForMember, Integer pageNumberForMember, String sortStringForMember, Boolean ascendingForMember, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved, Boolean pageIsCursorForMember, String pageLastCursorFieldForMember, String pageLastCursorFieldTypeForMember, Boolean pageCursorFieldIncludesLastRetrievedForMember, Boolean pointInTimeRetrieve, Timestamp pointInTimeFrom, Timestamp pointInTimeTo)
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 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.pointInTimeTo - 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.public static WsGetMembersLiteResult getMembersLite(GrouperVersion clientVersion, String groupName, String groupUuid, WsMemberFilter memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String sourceIds, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Boolean pointInTimeRetrieve, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
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 of sources to get members frompointInTimeRetrieve - 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.pointInTimeTo - 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.pageSize - 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 itempublic static WsGroupDeleteResults groupDelete(GrouperVersion clientVersion, WsGroupLookup[] wsGroupLookups, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, boolean includeGroupDetail, WsParam[] params)
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 usepublic static WsGroupDeleteLiteResult groupDeleteLite(GrouperVersion clientVersion, String groupName, String groupUuid, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
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 usepublic static WsGroupSaveResults groupSave(GrouperVersion clientVersion, WsGroupToSave[] wsGroupToSaves, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, boolean includeGroupDetail, WsParam[] params)
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 useGroup#saveGroup(GrouperSession, String, String, String, String, boolean, boolean, boolean)}public static WsExternalSubjectSaveResults externalSubjectSave(GrouperVersion clientVersion, WsExternalSubjectToSave[] wsExternalSubjectToSaves, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
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 usepublic static WsHasMemberResults hasMember(GrouperVersion clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, WsMemberFilter memberFilter, WsSubjectLookup actAsSubjectLookup, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, Timestamp pointInTimeFrom, Timestamp pointInTimeTo)
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)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.pointInTimeTo - 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.public static WsHasMemberLiteResult hasMemberLite(GrouperVersion clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, WsMemberFilter memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, Timestamp pointInTimeFrom, Timestamp pointInTimeTo)
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
duplicatesmemberFilter - 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 returnedsubjectIdentifier - 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)paramName0 - 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.pointInTimeTo - 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.public static WsMemberChangeSubjectLiteResult memberChangeSubjectLite(GrouperVersion clientVersion, String oldSubjectId, String oldSubjectSourceId, String oldSubjectIdentifier, String newSubjectId, String newSubjectSourceId, String newSubjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean deleteOldMember, boolean includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1)
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 insteadactAsSubjectId - 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 blankincludeSubjectDetail - 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 usepublic static WsMemberChangeSubjectResults memberChangeSubject(GrouperVersion clientVersion, WsMemberChangeSubject[] wsMemberChangeSubjects, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params)
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsMemberChangeSubjects - objects that describe one member renamingactAsSubjectLookup - to act as a different user than the logged in userincludeGroupDetail - 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 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.public static WsStemDeleteResults stemDelete(GrouperVersion clientVersion, WsStemLookup[] wsStemLookups, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
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 usepublic static WsStemDeleteLiteResult stemDeleteLite(GrouperVersion clientVersion, String stemName, String stemUuid, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
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 usepublic static WsStemSaveResults stemSave(GrouperVersion clientVersion, WsStemToSave[] wsStemToSaves, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
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 useGroup#saveGroup(GrouperSession, String, String, String, String, boolean, boolean, boolean)}public static WsStemSaveLiteResult stemSaveLite(GrouperVersion clientVersion, String stemLookupUuid, String stemLookupName, String stemUuid, String stemName, String displayExtension, String description, SaveMode saveMode, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
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 useStem#saveStem(GrouperSession, String, String, String, String, boolean, boolean, boolean)}public static WsGroupSaveLiteResult groupSaveLite(GrouperVersion clientVersion, String groupLookupUuid, String groupLookupName, String groupUuid, String groupName, String displayExtension, String description, SaveMode saveMode, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, TypeOfGroup typeOfGroup, String alternateName, Timestamp disabledTime, Timestamp enabledTime)
groupLookupUuid - the uuid of the group to save (mutually exclusive with groupLookupName), null for insertgroupLookupName - the name of the stam to save (mutually exclusive with groupLookupUuid), null for insertclientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000groupName - data of group to savegroupUuid - uuid data of group to savedescription - of the groupdisplayExtension - of the groupsaveMode - 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 usetypeOfGroup - type of group can be an enum of TypeOfGroup, e.g. group, role, entityalternateName - the alternate name of the groupdisabledTime - enabledTime - Group#saveGroup(GrouperSession, String, String, String, String, boolean, boolean, boolean)}public static WsGetGrouperPrivilegesLiteResult getGrouperPrivilegesLite(GrouperVersion clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String groupName, String groupUuid, String stemName, String stemUuid, PrivilegeType privilegeType, Privilege privilegeName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
get grouper privileges for a group or folder e.g. /grouperPrivileges/subjects/1234567/groups/aStem:aGroup/types/access/names/update e.g. /grouperPrivileges/subjects/sources/someSource/subjectId/1234567/stems/aStem1:aStem2/
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 usepublic static void removePrivsNotAllowedToSee(Set<GrouperPrivilege> privileges)
privileges - public static void removePrivsNotAllowedToSee(TreeSet<GrouperPrivilege> privileges)
privileges - public static WsAssignGrouperPrivilegesLiteResult assignGrouperPrivilegesLite(GrouperVersion clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String groupName, String groupUuid, String stemName, String stemUuid, PrivilegeType privilegeType, Privilege privilegeName, boolean allowed, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
assign a privilege for a user/group/type/name combo e.g. /grouperPrivileges/subjects/1234567/groups/aStem:aGroup/types/access/names/update e.g. /grouperPrivileges/subjects/sources/someSource/subjectId/1234567/stems/aStem1:aStem2/
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)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 includedparamName0 - reserved for future useparamValue0 - reserved for future useparamName1 - reserved for future useparamValue1 - reserved for future usepublic static WsGetSubjectsResults getSubjects(GrouperVersion clientVersion, WsSubjectLookup[] wsSubjectLookups, String searchString, boolean includeSubjectDetail, String[] subjectAttributeNames, WsSubjectLookup actAsSubjectLookup, String[] sourceIds, WsGroupLookup wsGroupLookup, WsMemberFilter wsMemberFilter, Field fieldName, boolean includeGroupDetail, WsParam[] params)
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)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)public static WsGetSubjectsResults getSubjectsLite(GrouperVersion clientVersion, String subjectId, String sourceId, String subjectIdentifier, String searchString, boolean includeSubjectDetail, String subjectAttributeNames, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String sourceIds, String groupName, String groupUuid, WsMemberFilter wsMemberFilter, Field fieldName, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
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)public static WsAssignGrouperPrivilegesResults assignGrouperPrivileges(GrouperVersion clientVersion, WsSubjectLookup[] wsSubjectLookups, WsGroupLookup wsGroupLookup, WsStemLookup wsStemLookup, PrivilegeType privilegeType, Privilege[] privilegeNames, boolean allowed, boolean replaceAllExisting, GrouperTransactionType txType, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params)
assign a privilege for a user/group/type/name combo e.g. POST /grouperPrivileges
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsSubjectLookups - are the subjects to assign the privileges to, looked up by subjectId or identifierwsGroupLookup - if this is a group privilege, this is the groupwsStemLookup - if this is a stem privilege, this is the stemreplaceAllExisting - optional: T or F (default), If 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 usepublic static WsGetAttributeAssignmentsResults getAttributeAssignments(GrouperVersion clientVersion, AttributeAssignType attributeAssignType, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsAttributeDefLookup[] wsAttributeDefLookups, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsGroupLookup[] wsOwnerGroupLookups, WsStemLookup[] wsOwnerStemLookups, WsSubjectLookup[] wsOwnerSubjectLookups, WsMembershipLookup[] wsOwnerMembershipLookups, WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, String[] actions, boolean includeAssignmentsOnAssignments, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params, String enabled, AttributeDefValueType attributeDefValueType, Object theValue, boolean includeAssignmentsFromAssignments, AttributeDefType attributeDefType, WsAttributeAssignLookup[] wsAssignAssignOwnerAttributeAssignLookups, WsAttributeDefLookup[] wsAssignAssignOwnerAttributeDefLookups, WsAttributeDefNameLookup[] wsAssignAssignOwnerAttributeDefNameLookups, String[] wsAssignAssignOwnerActions)
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 topublic static WsGetAttributeAssignmentsResults getAttributeAssignmentsLite(GrouperVersion clientVersion, AttributeAssignType 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, boolean includeAssignmentsOnAssignments, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String enabled, AttributeDefValueType attributeDefValueType, Object theValue, boolean includeAssignmentsFromAssignments, AttributeDefType attributeDefType, String wsAssignAssignOwnerAttributeAssignId, String wsAssignAssignOwnerIdOfAttributeDef, String wsAssignAssignOwnerNameOfAttributeDef, String wsAssignAssignOwnerIdOfAttributeDefName, String wsAssignAssignOwnerNameOfAttributeDefName, String wsAssignAssignOwnerAction)
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 - act as this subjectactAsSubjectSourceId - act as this subjectactAsSubjectIdentifier - act as this subjectincludeSubjectDetail - 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, 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, 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 topublic static WsGetAttributeAssignActionsResults getAttributeAssignActions(GrouperVersion clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
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 usepublic static WsGetAttributeAssignActionsResults getAttributeAssignActionsLite(GrouperVersion clientVersion, String wsNameOfAttributeDef, String wsIdOfAttributeDef, String wsIdIndexOfAttributeDef, String action, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsNameOfAttributeDef - find assignments in this attribute defwsIdOfAttributeDef - find assignments in this attribute def (optional)wsIdIndexOfAttributeDef - find assignments in this attribute def (optional)action - to query, or none to query all actionsactAsSubjectId - act as this subjectactAsSubjectSourceId - act as this subjectactAsSubjectIdentifier - act as this subjectparamName0 - reserved for future useparamValue0 - reserved for future useparamName1 - reserved for future useparamValue1 - reserved for future usepublic static WsAssignAttributesResults assignAttributes(GrouperVersion clientVersion, AttributeAssignType attributeAssignType, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, AttributeAssignOperation attributeAssignOperation, WsAttributeAssignValue[] values, String assignmentNotes, Timestamp assignmentEnabledTime, Timestamp assignmentDisabledTime, AttributeAssignDelegatable delegatable, AttributeAssignValueOperation attributeAssignValueOperation, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsGroupLookup[] wsOwnerGroupLookups, WsStemLookup[] wsOwnerStemLookups, WsSubjectLookup[] wsOwnerSubjectLookups, WsMembershipLookup[] wsOwnerMembershipLookups, WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, WsAttributeAssignLookup[] wsOwnerAttributeAssignLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params, WsAttributeDefLookup[] attributeDefsToReplace, String[] actionsToReplace, String[] attributeDefTypesToReplace)
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 allpublic static WsAssignAttributesLiteResults assignAttributesLite(GrouperVersion clientVersion, AttributeAssignType attributeAssignType, String wsAttributeDefNameName, String wsAttributeDefNameId, AttributeAssignOperation attributeAssignOperation, String valueId, String valueSystem, String valueFormatted, String assignmentNotes, Timestamp assignmentEnabledTime, Timestamp assignmentDisabledTime, AttributeAssignDelegatable delegatable, AttributeAssignValueOperation 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, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
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 usepublic static WsAttributeDefSaveResults attributeDefSave(GrouperVersion clientVersion, WsAttributeDefToSave[] wsAttributeDefsToSave, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
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 useAttributeDefSave#save()}public static WsAttributeDefSaveLiteResult attributeDefSaveLite(GrouperVersion clientVersion, String attributeDefLookupUuid, String attributeDefLookupName, String uuidOfAttributeDef, String nameOfAttributeDef, Boolean assignToAttributeDef, Boolean assignToAttributeDefAssignment, Boolean assignToEffectiveMembership, Boolean assignToEffectiveMembershipAssignment, Boolean assignToGroup, Boolean assignToGroupAssignment, Boolean assignToImmediateMembership, Boolean assignToImmediateMembershipAssignment, Boolean assignToMember, Boolean assignToMemberAssignment, Boolean assignToStem, Boolean assignToStemAssignment, String attributeDefType, String multiAssignable, String multiValued, String valueType, String description, SaveMode saveMode, Boolean createParentStemsIfNotExist, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
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 attributeDefName 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 useAttributeDefSave#save()}public static WsAttributeDefDeleteResults attributeDefDelete(GrouperVersion clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, GrouperTransactionType txType, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeDefLookups - find assignments in these attribute defstxType - 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.actAsSubjectLookup - params - optional: reserved for future usepublic static WsAttributeDefDeleteLiteResult attributeDefDeleteLite(GrouperVersion clientVersion, String wsNameOfAttributeDef, String wsIdOfAttributeDef, String wsIdIndexOfAttributeDef, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsNameOfAttributeDef - find assignments in this attribute defwsIdOfAttributeDef - find assignments in this attribute def (optional)wsIdIndexOfAttributeDef - find assignments in this attribute def (optional)actAsSubjectId - act as this subjectactAsSubjectSourceId - act as this subjectactAsSubjectIdentifier - act as this subjectparamName0 - reserved for future useparamValue0 - reserved for future useparamName1 - reserved for future useparamValue1 - reserved for future usepublic static WsFindAttributeDefsResults findAttributeDefs(GrouperVersion clientVersion, String scope, Boolean splitScope, WsAttributeDefLookup[] wsAttributeDefLookups, String privilegeName, StemScope stemScope, String parentStemId, Boolean findByUuidOrName, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, WsSubjectLookup actAsSubjectLookup, WsParam[] params, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
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 itempublic static WsFindAttributeDefsResults findAttributeDefsLite(GrouperVersion clientVersion, String scope, Boolean splitScope, String uuidOfAttributeDef, String nameOfAttributeDef, String idIndexOfAttributeDef, String privilegeName, StemScope stemScope, String parentStemId, Boolean findByUuidOrName, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
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 usepublic static WsAttributeDefAssignActionResults assignAttributeDefActions(GrouperVersion clientVersion, WsAttributeDefLookup wsAttributeDefLookup, String[] actions, boolean assign, Boolean replaceAllExisting, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsAttributeDefLookup - attribute def 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 usepublic static WsGetPermissionAssignmentsResults getPermissionAssignments(GrouperVersion clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsGroupLookup[] roleLookups, WsSubjectLookup[] wsSubjectLookups, String[] actions, boolean includePermissionAssignDetail, boolean includeAttributeDefNames, boolean includeAttributeAssignments, boolean includeAssignmentsOnAssignments, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params, String enabled, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, boolean immediateOnly, PermissionEntry.PermissionType permissionType, PermissionProcessor permissionProcessor, WsPermissionEnvVar[] limitEnvVars, boolean includeLimits)
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.pointInTimeTo - 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.immediateOnly - 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 listspublic static WsGetPermissionAssignmentsResults getPermissionAssignmentsLite(GrouperVersion clientVersion, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String roleName, String roleId, String wsSubjectId, String wsSubjectSourceId, String wsSubjectIdentifier, String action, boolean includePermissionAssignDetail, boolean includeAttributeDefNames, boolean includeAttributeAssignments, boolean includeAssignmentsOnAssignments, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String enabled, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, boolean immediateOnly, PermissionEntry.PermissionType permissionType, PermissionProcessor permissionProcessor, String limitEnvVarName0, String limitEnvVarValue0, String limitEnvVarType0, String limitEnvVarName1, String limitEnvVarValue1, String limitEnvVarType1, boolean includeLimits)
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.pointInTimeTo - 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.immediateOnly - 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 listspublic static WsAssignPermissionsResults assignPermissions(GrouperVersion clientVersion, PermissionEntry.PermissionType permissionType, WsAttributeDefNameLookup[] permissionDefNameLookups, PermissionAssignOperation permissionAssignOperation, String assignmentNotes, Timestamp assignmentEnabledTime, Timestamp assignmentDisabledTime, AttributeAssignDelegatable delegatable, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsGroupLookup[] roleLookups, WsMembershipAnyLookup[] subjectRoleLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params, WsAttributeDefLookup[] attributeDefsToReplace, String[] actionsToReplace, Boolean disallowed)
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 - is disallowedpublic static WsAssignPermissionsLiteResults assignPermissionsLite(GrouperVersion clientVersion, PermissionEntry.PermissionType permissionType, String permissionDefNameName, String permissionDefNameId, PermissionAssignOperation permissionAssignOperation, String assignmentNotes, Timestamp assignmentEnabledTime, Timestamp assignmentDisabledTime, AttributeAssignDelegatable 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, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, Boolean disallowed)
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 - if the assignment is a disallowpublic static WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritance(GrouperVersion clientVersion, WsAttributeDefNameLookup wsAttributeDefNameLookup, WsAttributeDefNameLookup[] relatedWsAttributeDefNameLookups, boolean assign, Boolean replaceAllExisting, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
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 usepublic static WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritanceLite(GrouperVersion clientVersion, String attributeDefNameUuid, String attributeDefNameName, String relatedAttributeDefNameUuid, String relatedAttributeDefNameName, boolean assign, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
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 usepublic static WsAttributeDefNameDeleteResults attributeDefNameDelete(GrouperVersion clientVersion, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
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 usepublic static WsAttributeDefNameDeleteLiteResult attributeDefNameDeleteLite(GrouperVersion clientVersion, String attributeDefNameUuid, String attributeDefNameName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
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, entitypublic static WsAttributeDefNameSaveResults attributeDefNameSave(GrouperVersion clientVersion, WsAttributeDefNameToSave[] wsAttributeDefNameToSaves, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
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 useAttributeDefNameSave#save()}public static WsAttributeDefNameSaveLiteResult attributeDefNameSaveLite(GrouperVersion clientVersion, String attributeDefNameLookupUuid, String attributeDefNameLookupName, String attributeDefLookupUuid, String attributeDefLookupName, String attributeDefNameUuid, String attributeDefNameName, String displayExtension, String description, SaveMode saveMode, Boolean createParentStemsIfNotExist, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
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 useAttributeDefNameSave#save()}public static WsFindAttributeDefNamesResults findAttributeDefNames(GrouperVersion clientVersion, String scope, Boolean splitScope, WsAttributeDefLookup wsAttributeDefLookup, AttributeAssignType attributeAssignType, AttributeDefType attributeDefType, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, WsInheritanceSetRelation wsInheritanceSetRelation, WsSubjectLookup actAsSubjectLookup, WsParam[] params, WsSubjectLookup wsSubjectLookup, ServiceRole serviceRole, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
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 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 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 rolepublic static WsFindAttributeDefNamesResults findAttributeDefNamesLite(GrouperVersion clientVersion, String scope, Boolean splitScope, String uuidOfAttributeDef, String nameOfAttributeDef, AttributeAssignType attributeAssignType, AttributeDefType attributeDefType, String attributeDefNameUuid, String attributeDefNameName, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, WsInheritanceSetRelation wsInheritanceSetRelation, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, String subjectId, String subjectSourceId, String subjectIdentifier, ServiceRole serviceRole, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
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 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 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 rolepublic static WsAssignAttributesBatchResults assignAttributesBatch(GrouperVersion clientVersion, WsAssignAttributeBatchEntry[] wsAssignAttributeBatchEntries, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, GrouperTransactionType txType, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params)
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.public static WsMessageResults sendMessage(GrouperVersion clientVersion, edu.internet2.middleware.grouperClient.messaging.GrouperMessageQueueType queueType, String queueOrTopicName, String messageSystemName, String routingKey, String exchangeType, Map<String,Object> queueArguments, Boolean autocreateObjects, WsMessage[] messages, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
clientVersion - queueType - - queue or topic (required)queueOrTopicName - - queue or topic to send to (required)messageSystemName - - if there are multiple messaging systems, specify which one (optional)routingKey - - valid for only rabbitmq. ignored otherwise.queueArguments - autocreateObjects - - create queue/topic if not there already.messages - - payload to be sent (required)actAsSubjectLookup - params - public static WsMessageResults receiveMessage(GrouperVersion clientVersion, edu.internet2.middleware.grouperClient.messaging.GrouperMessageQueueType queueType, String queueOrTopicName, String messageSystemName, String routingKey, String exchangeType, Map<String,Object> queueArguments, Boolean autocreateObjects, Integer blockMillis, Integer maxMessagesToReceiveAtOnce, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
clientVersion - queueOrTopicName - - queue or topic to receive from (required)messageSystemName - - if there are multiple messaging systems, specify which one (optional)routingKey - - valid for rabbitmq, ignored otherwise.autocreateObjects - - create queue/topic if not there alreadyblockMillis - - 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 - public static WsMessageAcknowledgeResults acknowledge(GrouperVersion clientVersion, String queueOrTopicName, String messageSystemName, edu.internet2.middleware.grouperClient.messaging.GrouperMessageAcknowledgeType acknowledgeType, String[] messageIds, String anotherQueueOrTopicName, edu.internet2.middleware.grouperClient.messaging.GrouperMessageQueueType anotherQueueType, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
clientVersion - queueOrTopicName - - queue or topic to receive from (required)messageSystemName - - if there are multiple messaging systems, specify which one (optional)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 - public static WsExternalSubjectDeleteResults externalSubjectDelete(GrouperVersion clientVersion, WsExternalSubjectLookup[] wsExternalSubjectLookups, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
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 usepublic static WsFindExternalSubjectsResults findExternalSubjects(GrouperVersion clientVersion, WsExternalSubjectLookup[] wsExternalSubjectLookups, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
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 namespublic static WsGetAuditEntriesResults getAuditEntriesLite(GrouperVersion 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, Integer pageSize, String sortString, Boolean ascending, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved, Timestamp fromDate, Timestamp toDate)
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 itemfromDate - toDate - public static WsGetAuditEntriesResults getAuditEntries(GrouperVersion clientVersion, WsSubjectLookup actAsSubjectLookup, String auditType, String auditActionId, WsGroupLookup wsGroupLookup, WsStemLookup wsStemLookup, WsAttributeDefLookup wsAttributeDefLookup, WsAttributeDefNameLookup wsAttributeDefNameLookup, WsSubjectLookup wsSubjectLookup, WsSubjectLookup actionsPerformedByWsSubjectLookup, WsParam[] params, Integer pageSize, String sortString, Boolean ascending, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved, Timestamp fromDate, Timestamp toDate)
clientVersion - actAsSubjectLookup - auditType - auditActionId - wsGroupLookup - wsStemLookup - wsAttributeDefLookup - wsAttributeDefNameLookup - wsSubjectLookup - actionsPerformedByWsSubjectLookup - 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 - public static WsGshTemplateExecResult executeGshTemplate(GrouperVersion clientVersion, String configId, GshTemplateOwnerType ownerType, WsGroupLookup ownerGroupLookup, WsStemLookup ownerStemLookup, WsGshTemplateInput[] inputs, WsSubjectLookup gshTemplateActAsSubjectLookup, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000configId - configId of the template to executeownerType - stem or groupownerGroupLookup - owner group when ownerType is groupownerStemLookup - owner stem when ownerType is steminputs - name/value pairs to inject into the template at runtimeparams - optional: reserved for future useCopyright © 2016 Internet2. All rights reserved.