Class GrouperServiceRest
java.lang.Object
edu.internet2.middleware.grouper.ws.rest.GrouperServiceRest
consolidated static list of of rest web services (only web service methods here
to have clean javadoc). the method name corresponds to the url and request method.
e.g. "GET /groups/a:b:c/members" will correspond to groupMembersGet()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic WsMessageAcknowledgeResults
acknowledgeMessages
(GrouperVersion clientVersion, WsRestAcknowledgeMessageRequest wsRestMessageAcknowledgeRequest) acknowledge message(s)static WsAddMemberResults
addMember
(GrouperVersion clientVersion, String groupName, WsRestAddMemberRequest wsRestAddMembersRequest) based on a group name, put multiple members, or all members.static WsAddMemberLiteResult
addMemberLite
(GrouperVersion clientVersion, String groupName, String subjectId, String sourceId, WsRestAddMemberLiteRequest wsRestAddMemberLiteRequest) based on a group name, put the memberassignAttributeDefActions
(GrouperVersion clientVersion, WsRestAssignAttributeDefActionsRequest wsRestAssignAttributeDefActionsRequest) assign actions to attribute defassignAttributeDefNameInheritance
(GrouperVersion clientVersion, WsRestAssignAttributeDefNameInheritanceRequest wsRestAssignAttributeDefNameInheritanceRequest) assign or unassign attribute def name permission inheritanceassignAttributeDefNameInheritanceLite
(GrouperVersion clientVersion, WsRestAssignAttributeDefNameInheritanceLiteRequest wsRestAssignAttributeDefNameInheritanceLiteRequest) assign or unassign attribute def name permission inheritancestatic WsAssignAttributesResults
assignAttributes
(GrouperVersion clientVersion, WsRestAssignAttributesRequest wsRestAssignAttributesRequest) assign attributes restassignAttributesBatch
(GrouperVersion clientVersion, WsRestAssignAttributesBatchRequest wsRestAssignAttributesBatchRequest) assign attributes batch restassignAttributesLite
(GrouperVersion clientVersion, WsRestAssignAttributesLiteRequest wsRestAssignAttributesLiteRequest) assign attributes rest for one owner (lite)assignGrouperPrivileges
(GrouperVersion clientVersion, WsRestAssignGrouperPrivilegesRequest wsRestAssignGrouperPrivilegeRequest) assign privileges.assignGrouperPrivilegesLite
(GrouperVersion clientVersion, WsRestAssignGrouperPrivilegesLiteRequest wsRestAssignGrouperPrivilegesLiteRequest) assign/revoke privileges for a group or stem and subjectstatic WsAssignPermissionsResults
assignPermissions
(GrouperVersion clientVersion, WsRestAssignPermissionsRequest wsRestAssignPermissionsRequest) assign permissions restassignPermissionsLite
(GrouperVersion clientVersion, WsRestAssignPermissionsLiteRequest wsRestAssignPermissionsLiteRequest) assign attributes rest for one owner (lite)static WsAttributeDefDeleteResults
attributeDefDelete
(GrouperVersion clientVersion, WsRestAttributeDefDeleteRequest wsRestAttributeDefDeleteRequest) based on a submitted object of type WsRestAttributeDefDeleteRequest, delete the attributeDefs.attributeDefDeleteLite
(GrouperVersion clientVersion, WsRestAttributeDefDeleteLiteRequest wsRestAttributeDefDeleteLiteRequest) attributeDefNameDelete
(GrouperVersion clientVersion, WsRestAttributeDefNameDeleteRequest wsRestAttributeDefNameDeleteRequest) delete an AttributeDefName or many.attributeDefNameDeleteLite
(GrouperVersion clientVersion, String attributeDefName, WsRestAttributeDefNameDeleteLiteRequest wsRestAttributeDefNameDeleteLiteRequest) delete an AttributeDefNameattributeDefNameSave
(GrouperVersion clientVersion, WsRestAttributeDefNameSaveRequest wsRestAttributeDefNameSaveRequest) save an AttributeDefName or many (insert or update).attributeDefNameSaveLite
(GrouperVersion clientVersion, String attributeDefNameLookupName, WsRestAttributeDefNameSaveLiteRequest wsRestAttributeDefNameSaveLiteRequest) save an AttributeDefName (insert or update).static WsAttributeDefSaveResults
attributeDefSave
(GrouperVersion clientVersion, WsRestAttributeDefSaveRequest wsRestAttributeDefSaveRequest) save an AttributeDef or many (insert or update).static WsAttributeDefSaveLiteResult
attributeDefSaveLite
(GrouperVersion clientVersion, String attributeDefLookupName, WsRestAttributeDefSaveLiteRequest wsRestAttributeDefSaveLiteRequest) save an AttributeDef (insert or update).static WsDeleteMemberResults
deleteMember
(GrouperVersion clientVersion, String groupName, WsRestDeleteMemberRequest wsRestDeleteMembersRequest) based on a group name, put multiple members, or all members.static WsDeleteMemberLiteResult
deleteMemberLite
(GrouperVersion clientVersion, String groupName, String subjectId, String sourceId, WsRestDeleteMemberLiteRequest wsRestDeleteMemberLiteRequest) based on a group name, delete the memberstatic WsGshTemplateExecResult
executeGshTemplate
(GrouperVersion clientVersion, WsRestGshTemplateExecRequest wsRestGshTemplateExecRequest) based on a submitted object of type WsRestGshTemplateExecRequest, execute gsh template /v1_3_000/gshTemplateExecexternalSubjectDelete
(GrouperVersion clientVersion, WsRestExternalSubjectDeleteRequest wsRestExternalSubjectDeleteRequest) based on a submitted object of type WsRestExternalSubjectDeleteRequest, delete the external subjects.static WsExternalSubjectSaveResults
externalSubjectSave
(GrouperVersion clientVersion, WsRestExternalSubjectSaveRequest wsRestExternalSubjectSaveRequest) based on a submitted object of type WsRestExternalSubjectSaveRequest, save external subjects.findAttributeDefNames
(GrouperVersion clientVersion, WsRestFindAttributeDefNamesRequest wsRestFindAttributeDefNamesRequest) find an attribute def name or attribute def names.findAttributeDefNamesLite
(GrouperVersion clientVersion, String attributeDefNameName, WsRestFindAttributeDefNamesLiteRequest wsRestFindAttributeDefNamesLiteRequest) find an attribute def name or attribute def names.static WsFindAttributeDefsResults
findAttributeDefs
(GrouperVersion clientVersion, WsRestFindAttributeDefsRequest wsRestFindAttributeDefsRequest) find an attribute def or attribute defs.static WsFindAttributeDefsResults
findAttributeDefsLite
(GrouperVersion clientVersion, WsRestFindAttributeDefsLiteRequest wsRestFindAttributeDefsLiteRequest) find an attribute def or attribute defs.findExternalSubjects
(GrouperVersion clientVersion, WsRestFindExternalSubjectsRequest wsRestFindExternalSubjectsRequest) based on an external subject query, get the external subjectsstatic WsFindGroupsResults
findGroups
(GrouperVersion clientVersion, WsRestFindGroupsRequest wsRestFindGroupsRequest) based on a group query, get the groupsstatic WsFindGroupsResults
findGroupsLite
(GrouperVersion clientVersion, WsRestFindGroupsLiteRequest wsRestFindGroupsLiteRequest) based on a group query, get the groupsstatic WsFindStemsResults
findStems
(GrouperVersion clientVersion, WsRestFindStemsRequest wsRestFindStemsRequest) based on a stem query, get the stemsstatic WsFindStemsResults
findStemsLite
(GrouperVersion clientVersion, WsRestFindStemsLiteRequest wsRestFindStemsLiteRequest) based on a stem query, get the stemsgetAttributeAssignActions
(GrouperVersion clientVersion, WsRestGetAttributeAssignActionsRequest wsRestGetAttributeAssignActionsRequest) get attribute assign actions restgetAttributeAssignActionsLite
(GrouperVersion clientVersion, WsRestGetAttributeAssignActionsLiteRequest wsRestGetAttributeAssignActionsLiteRequest) get attribute assign actions rest for one attribute definitiongetAttributeAssignments
(GrouperVersion clientVersion, WsRestGetAttributeAssignmentsRequest wsRestGetAttributesRequest) get attribute assignments restgetAttributeAssignmentsLite
(GrouperVersion clientVersion, WsRestGetAttributeAssignmentsLiteRequest wsRestGetAttributesLiteRequest) get attribute assignments rest for one owner (lite)static WsGetAuditEntriesResults
getAuditEntries
(GrouperVersion clientVersion, WsRestGetAuditEntriesRequest wsRestGetAuditEntriesRequest) based on query, get auditsstatic WsGetAuditEntriesResults
getAuditEntriesLite
(GrouperVersion clientVersion, WsRestGetAuditEntriesLiteRequest wsRestGetAuditEntriesLiteRequest) based on query, get auditsgetGrouperPrivilegesLite
(GrouperVersion clientVersion, WsRestGetGrouperPrivilegesLiteRequest wsRestGetGrouperPrivilegesLiteRequest) get privileges for a group or stem and subjectstatic WsGetGroupsResults
getGroups
(GrouperVersion clientVersion, String subjectId, String sourceId, WsRestGetGroupsRequest wsRestGetGroupsRequest) based a subject object of type WsRestGetGroupsRequest, get the groups /v1_3_000/subjects/123/groupsstatic WsGetGroupsLiteResult
getGroupsLite
(GrouperVersion clientVersion, String subjectId, String sourceId, WsRestGetGroupsLiteRequest wsRestGetGroupsLiteRequest) based on a subject, get the groups associatedstatic WsGetMembersResults
getMembers
(GrouperVersion clientVersion, WsRestGetMembersRequest wsRestGetMembersRequest) based on a group name, get members .static WsGetMembershipsResults
getMemberships
(GrouperVersion clientVersion, String groupName, String subjectId, String sourceId, WsRestGetMembershipsRequest wsRestGetMembershipsRequest) based on a group name, get memberships.static WsGetMembershipsResults
getMembershipsLite
(GrouperVersion clientVersion, String groupName, String subjectId, String sourceId, WsRestGetMembershipsLiteRequest wsRestGetMembershipsLiteRequest) based on a group name, get memberships.static WsGetMembersLiteResult
getMembersLite
(GrouperVersion clientVersion, String groupName, WsRestGetMembersLiteRequest wsRestGetMembersLiteRequest) based on a group name, get the membersgetPermissionAssignments
(GrouperVersion clientVersion, WsRestGetPermissionAssignmentsRequest wsRestGetPermissionAssignmentsRequest) get permission assignments restgetPermissionAssignmentsLite
(GrouperVersion clientVersion, WsRestGetPermissionAssignmentsLiteRequest wsRestGetPermissionAssignmentsLiteRequest) get permission assignments rest for one owner (lite)static WsGetSubjectsResults
getSubjects
(GrouperVersion clientVersion, String subjectId, String sourceId, WsRestGetSubjectsRequest wsRestGetSubjectsRequest) find subjects by id or search string.static WsGetSubjectsResults
getSubjectsLite
(GrouperVersion clientVersion, String subjectId, String sourceId, WsRestGetSubjectsLiteRequest wsRestGetSubjectsLiteRequest) find subjects by id or search string.static WsGroupDeleteResults
groupDelete
(GrouperVersion clientVersion, WsRestGroupDeleteRequest wsRestGroupDeleteRequest) based on a submitted object of type WsRestGroupDeleteRequest, delete the groups.static WsGroupDeleteLiteResult
groupDeleteLite
(GrouperVersion clientVersion, String groupName, WsRestGroupDeleteLiteRequest wsRestGroupDeleteLiteRequest) based on a group name, delete a groupstatic WsGroupSaveResults
groupSave
(GrouperVersion clientVersion, WsRestGroupSaveRequest wsRestGroupSaveRequest) based on a submitted object of type WsRestGroupSaveRequest, save groups.static WsGroupSaveLiteResult
groupSaveLite
(GrouperVersion clientVersion, String groupLookupName, WsRestGroupSaveLiteRequest wsRestGroupSaveLiteRequest) based on a group name and submitted object type WsRestGroupSaveLiteRequest, save a group.static WsHasMemberResults
hasMember
(GrouperVersion clientVersion, String groupName, WsRestHasMemberRequest wsRestHasMembersRequest) based on a group name, and multiple subjects, see if they are members .static WsHasMemberLiteResult
hasMemberLite
(GrouperVersion clientVersion, String groupName, String subjectId, String sourceId, WsRestHasMemberLiteRequest wsRestHasMemberLiteRequest) based on a group name, and a subject, see if memberstatic WsMemberChangeSubjectResults
memberChangeSubject
(GrouperVersion clientVersion, WsRestMemberChangeSubjectRequest wsRestMemberChangeSubjectRequest) based on a member, change the subject e.g.memberChangeSubjectLite
(GrouperVersion clientVersion, String oldSubjectId, String oldSubjectSourceId, WsRestMemberChangeSubjectLiteRequest wsRestMemberChangeSubjectLiteRequest) based on a member, change the subjectstatic WsMessageResults
receiveMessage
(GrouperVersion clientVersion, WsRestReceiveMessageRequest wsRestReceiveMessageRequest) receive message(s)static WsMessageResults
sendMessage
(GrouperVersion clientVersion, WsRestSendMessageRequest wsRestSendMessageRequest) send message(s)static WsStemDeleteResults
stemDelete
(GrouperVersion clientVersion, WsRestStemDeleteRequest wsRestStemDeleteRequest) based on submitted object of type WsRestStemDeleteRequest, delete stems /v1_3_000/groups/aStem:aGroup/membersstatic WsStemDeleteLiteResult
stemDeleteLite
(GrouperVersion clientVersion, String stemName, WsRestStemDeleteLiteRequest wsRestStemDeleteLiteRequest) based on a stem name, delete the stem url e.g.static WsStemSaveResults
stemSave
(GrouperVersion clientVersion, WsRestStemSaveRequest wsRestStemSaveRequest) based on a submitted object of type WsRestStemSaveRequest, save stems.static WsStemSaveLiteResult
stemSaveLite
(GrouperVersion clientVersion, String stemLookupName, WsRestStemSaveLiteRequest wsRestStemSaveLiteRequest) based on a stem name and submitted object type WsRestStemSaveLiteRequest, save a stem.
-
Constructor Details
-
GrouperServiceRest
public GrouperServiceRest()
-
-
Method Details
-
findGroups
@POST @Path("/grouper-ws/servicesRest/vF_G_UPF/groups") public static WsFindGroupsResults findGroups(GrouperVersion clientVersion, WsRestFindGroupsRequest wsRestFindGroupsRequest) based on a group query, get the groups
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestFindGroupsRequest
- is the request body converted to an object- Returns:
- the results
-
findGroupsLite
public static WsFindGroupsResults findGroupsLite(GrouperVersion clientVersion, WsRestFindGroupsLiteRequest wsRestFindGroupsLiteRequest) based on a group query, get the groups
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestFindGroupsLiteRequest
- is the request body converted to an object- Returns:
- the results
-
getMembersLite
public static WsGetMembersLiteResult getMembersLite(GrouperVersion clientVersion, String groupName, WsRestGetMembersLiteRequest wsRestGetMembersLiteRequest) based on a group name, get the members
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group including stems, e.g. a:b:cwsRestGetMembersLiteRequest
- is the request body converted to an object- Returns:
- the results
-
addMemberLite
public static WsAddMemberLiteResult addMemberLite(GrouperVersion clientVersion, String groupName, String subjectId, String sourceId, WsRestAddMemberLiteRequest wsRestAddMemberLiteRequest) based on a group name, put the member
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group including stems, e.g. a:b:csubjectId
- from url, e.g. /v1_3_000/groups/aStem:aGroup/members/123412345sourceId
- from url (optional) e.g. /v1_3_000/groups/aStem:aGroup/members/sourceId/someSource/subjectId/123412345wsRestAddMemberLiteRequest
- is the request body converted to an object- Returns:
- the result
-
addMember
@POST @Path("/grouper-ws/servicesRest/vA_A_MEF/members") public static WsAddMemberResults addMember(GrouperVersion clientVersion, String groupName, WsRestAddMemberRequest wsRestAddMembersRequest) based on a group name, put multiple members, or all members. e.g. url: /v1_3_000/groups/aStem:aGroup/members
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group including stems, e.g. a:b:cwsRestAddMembersRequest
- is the request body converted to an object- Returns:
- the result
-
assignGrouperPrivileges
@POST @Path("/grouper-ws/servicesRest/vA_G_PRF/grouperPriveleges") public static WsAssignGrouperPrivilegesResults assignGrouperPrivileges(GrouperVersion clientVersion, WsRestAssignGrouperPrivilegesRequest wsRestAssignGrouperPrivilegeRequest) assign privileges. e.g. url: /v1_3_000/grouperPrivileges
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group including stems, e.g. a:b:cwsRestAssignGrouperPrivilegeRequest
- is the request body converted to an object- Returns:
- the result
-
deleteMemberLite
public static WsDeleteMemberLiteResult deleteMemberLite(GrouperVersion clientVersion, String groupName, String subjectId, String sourceId, WsRestDeleteMemberLiteRequest wsRestDeleteMemberLiteRequest) based on a group name, delete the member
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group including stems, e.g. a:b:csubjectId
- from url, e.g. /v1_3_000/groups/aStem:aGroup/members/123412345sourceId
- from url (optional) e.g. /v1_3_000/groups/aStem:aGroup/members/sourceId/someSource/subjectId/123412345wsRestDeleteMemberLiteRequest
- is the request body converted to an object- Returns:
- the result
-
deleteMember
@POST @Path("/grouper-ws/servicesRest/vD_M_EMF/members") public static WsDeleteMemberResults deleteMember(GrouperVersion clientVersion, String groupName, WsRestDeleteMemberRequest wsRestDeleteMembersRequest) based on a group name, put multiple members, or all members. e.g. url: /v1_3_000/groups/aStem:aGroup/members
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group including stems, e.g. a:b:cwsRestDeleteMembersRequest
- is the request body converted to an object- Returns:
- the result
-
hasMember
@POST @Path("/grouper-ws/servicesRest/vH_M_EML/members") public static WsHasMemberResults hasMember(GrouperVersion clientVersion, String groupName, WsRestHasMemberRequest wsRestHasMembersRequest) based on a group name, and multiple subjects, see if they are members . e.g. url: /v1_3_000/groups/aStem:aGroup/members
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group including stems, e.g. a:b:cwsRestHasMembersRequest
- is the request body converted to an object- Returns:
- the result
-
getMembers
@POST @Path("/grouper-ws/servicesRest/vG_E_MEF/members") public static WsGetMembersResults getMembers(GrouperVersion clientVersion, WsRestGetMembersRequest wsRestGetMembersRequest) based on a group name, get members . e.g. url: /v1_3_000/groups/aStem:aGroup/members
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group including stems, e.g. a:b:cwsRestGetMembersRequest
- is the request body converted to an object- Returns:
- the result
-
hasMemberLite
public static WsHasMemberLiteResult hasMemberLite(GrouperVersion clientVersion, String groupName, String subjectId, String sourceId, WsRestHasMemberLiteRequest wsRestHasMemberLiteRequest) based on a group name, and a subject, see if member
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group including stems, e.g. a:b:csubjectId
- from url, e.g. /v1_3_000/groups/aStem:aGroup/members/123412345sourceId
- from url (optional) e.g. /v1_3_000/groups/aStem:aGroup/members/sourceId/someSource/subjectId/123412345wsRestHasMemberLiteRequest
- is the request body converted to an object- Returns:
- the result
-
memberChangeSubject
@POST @Path("/grouper-ws/servicesRest/vM_C_SUL/members") public static WsMemberChangeSubjectResults memberChangeSubject(GrouperVersion clientVersion, WsRestMemberChangeSubjectRequest wsRestMemberChangeSubjectRequest) based on a member, change the subject e.g. url: /v1_3_000/members
- Parameters:
clientVersion
- version of client, e.g. v1_3_000oldSubjectId
- from url if applicableoldSubjectSourceId
- from url is applicablewsRestMemberChangeSubjectRequest
- is the request body converted to an object- Returns:
- the result
-
memberChangeSubjectLite
public static WsMemberChangeSubjectLiteResult memberChangeSubjectLite(GrouperVersion clientVersion, String oldSubjectId, String oldSubjectSourceId, WsRestMemberChangeSubjectLiteRequest wsRestMemberChangeSubjectLiteRequest) based on a member, change the subject
- Parameters:
clientVersion
- version of client, e.g. v1_3_000oldSubjectId
- from url, e.g. /v1_3_000/members/subjectId/123412345oldSubjectSourceId
- from url (optional) e.g. /v1_3_000/members/sourceId/someSource/subjectId/123412345/sourceId/12342wsRestMemberChangeSubjectLiteRequest
- is the request body converted to an object- Returns:
- the result
-
getGrouperPrivilegesLite
public static WsGetGrouperPrivilegesLiteResult getGrouperPrivilegesLite(GrouperVersion clientVersion, WsRestGetGrouperPrivilegesLiteRequest wsRestGetGrouperPrivilegesLiteRequest) get privileges for a group or stem and subject
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestGetGrouperPrivilegesLiteRequest
- is the request body converted to an object- Returns:
- the result
-
assignGrouperPrivilegesLite
public static WsAssignGrouperPrivilegesLiteResult assignGrouperPrivilegesLite(GrouperVersion clientVersion, WsRestAssignGrouperPrivilegesLiteRequest wsRestAssignGrouperPrivilegesLiteRequest) assign/revoke privileges for a group or stem and subject
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestAssignGrouperPrivilegesLiteRequest
- is the request body converted to an object- Returns:
- the result
-
getGroups
@POST @Path("/grouper-ws/servicesRest/vG_E_GRF/groups") public static WsGetGroupsResults getGroups(GrouperVersion clientVersion, String subjectId, String sourceId, WsRestGetGroupsRequest wsRestGetGroupsRequest) based a subject object of type WsRestGetGroupsRequest, get the groups /v1_3_000/subjects/123/groups
- Parameters:
clientVersion
- version of client, e.g. v1_3_000sourceId
- is the source of the servicesubjectId
- is the subject to search for groupswsRestGetGroupsRequest
- is the request body converted to an object- Returns:
- the result
-
getGroupsLite
public static WsGetGroupsLiteResult getGroupsLite(GrouperVersion clientVersion, String subjectId, String sourceId, WsRestGetGroupsLiteRequest wsRestGetGroupsLiteRequest) based on a subject, get the groups associated
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group including stems, e.g. a:b:csubjectId
- from url, e.g. /v1_3_000/groups/aStem:aGroup/members/123412345sourceId
- from url (optional) e.g. /v1_3_000/groups/aStem:aGroup/members/sourceId/someSource/subjectId/123412345wsRestGetGroupsLiteRequest
- is the request body converted to an object- Returns:
- the result
-
findStems
@POST @Path("/grouper-ws/servicesRest/vF_S_EMF/stems") public static WsFindStemsResults findStems(GrouperVersion clientVersion, WsRestFindStemsRequest wsRestFindStemsRequest) based on a stem query, get the stems
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestFindStemsRequest
- is the request body converted to an object- Returns:
- the results
-
findStemsLite
public static WsFindStemsResults findStemsLite(GrouperVersion clientVersion, WsRestFindStemsLiteRequest wsRestFindStemsLiteRequest) based on a stem query, get the stems
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestFindStemsLiteRequest
- is the request body converted to an object- Returns:
- the results
-
stemSave
@POST @Path("/grouper-ws/servicesRest/vS_T_SAL/stems") public static WsStemSaveResults stemSave(GrouperVersion clientVersion, WsRestStemSaveRequest wsRestStemSaveRequest) based on a submitted object of type WsRestStemSaveRequest, save stems. e.g. url: /v1_3_000/stems
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestStemSaveRequest
- is the request body converted to an object- Returns:
- the result
-
stemSaveLite
public static WsStemSaveLiteResult stemSaveLite(GrouperVersion clientVersion, String stemLookupName, WsRestStemSaveLiteRequest wsRestStemSaveLiteRequest) based on a stem name and submitted object type WsRestStemSaveLiteRequest, save a stem. url e.g. /v1_3_000/stems/aStem:aStem2
- Parameters:
clientVersion
- version of client, e.g. v1_3_000stemLookupName
- is the name of the stem to lookup and save (old name if changing) including parent stems, e.g. a:b:cwsRestStemSaveLiteRequest
- is the request body converted to an object- Returns:
- the result
-
stemDelete
@POST @Path("/grouper-ws/servicesRest/vS_T_DEL/stems") public static WsStemDeleteResults stemDelete(GrouperVersion clientVersion, WsRestStemDeleteRequest wsRestStemDeleteRequest) based on submitted object of type WsRestStemDeleteRequest, delete stems /v1_3_000/groups/aStem:aGroup/members
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestStemDeleteRequest
- is the request body converted to an object- Returns:
- the result
-
stemDeleteLite
public static WsStemDeleteLiteResult stemDeleteLite(GrouperVersion clientVersion, String stemName, WsRestStemDeleteLiteRequest wsRestStemDeleteLiteRequest) based on a stem name, delete the stem url e.g. /v1_3_000/stems/aStem:aStem2
- Parameters:
clientVersion
- version of client, e.g. v1_3_000stemName
- is the name of the stem to delete including parent stems, e.g. a:b:cwsRestStemDeleteLiteRequest
- is the request body converted to an object- Returns:
- the result
-
groupDelete
@POST @Path("/grouper-ws/servicesRest/vG_R_DEF/groups") public static WsGroupDeleteResults groupDelete(GrouperVersion clientVersion, WsRestGroupDeleteRequest wsRestGroupDeleteRequest) based on a submitted object of type WsRestGroupDeleteRequest, delete the groups. e.g. url: /v1_3_000/groups
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestGroupDeleteRequest
- is the request body converted to an object- Returns:
- the result
-
groupDeleteLite
public static WsGroupDeleteLiteResult groupDeleteLite(GrouperVersion clientVersion, String groupName, WsRestGroupDeleteLiteRequest wsRestGroupDeleteLiteRequest) based on a group name, delete a group
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group to delete including parent stems, e.g. a:b:csubjectId
- from url, e.g. /v1_3_000/groups/aStem:aGroup/members/123412345sourceId
- from url (optional) e.g. /v1_3_000/groups/aStem:aGroup/members/sourceId/someSource/subjectId/123412345wsRestGroupDeleteLiteRequest
- is the request body converted to an object- Returns:
- the result
-
groupSave
@POST @Path("/grouper-ws/servicesRest/vG_R_SAF/groups") public static WsGroupSaveResults groupSave(GrouperVersion clientVersion, WsRestGroupSaveRequest wsRestGroupSaveRequest) based on a submitted object of type WsRestGroupSaveRequest, save groups. e.g. url: /v1_3_000/groups
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestGroupSaveRequest
- is the request body converted to an object- Returns:
- the result
-
groupSaveLite
public static WsGroupSaveLiteResult groupSaveLite(GrouperVersion clientVersion, String groupLookupName, WsRestGroupSaveLiteRequest wsRestGroupSaveLiteRequest) based on a group name and submitted object type WsRestGroupSaveLiteRequest, save a group. url e.g. /v1_3_000/groups/aStem:aGroup2
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupLookupName
- is the name of the group to lookup and save (old name if changing) including parent groups, e.g. a:b:cwsRestGroupSaveLiteRequest
- is the request body converted to an object- Returns:
- the result
-
getMemberships
@POST @Path("/grouper-ws/servicesRest/vG_E_MSF/memberships") public static WsGetMembershipsResults getMemberships(GrouperVersion clientVersion, String groupName, String subjectId, String sourceId, WsRestGetMembershipsRequest wsRestGetMembershipsRequest) based on a group name, get memberships. e.g. url: /v1_3_000/groups/aStem:aGroup/memberships /v1_3_000/subjects/12345678/memberships /v1_3_000/memberships
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group (optional)subjectId
- is the subjectId (optional)sourceId
- is the source id of the subject to search for (optional)wsRestGetMembershipsRequest
- is the request body converted to an object- Returns:
- the result
-
getMembershipsLite
public static WsGetMembershipsResults getMembershipsLite(GrouperVersion clientVersion, String groupName, String subjectId, String sourceId, WsRestGetMembershipsLiteRequest wsRestGetMembershipsLiteRequest) based on a group name, get memberships. e.g. url: /v1_3_000/groups/aStem:aGroup/memberships /v1_3_000/subjects/12345678/memberships /v1_3_000/memberships
- Parameters:
clientVersion
- version of client, e.g. v1_3_000groupName
- is the name of the group (optional)subjectId
- is the subjectId (optional)sourceId
- is the source id of the subject to search for (optional)wsRestGetMembershipsLiteRequest
- is the request body converted to an object- Returns:
- the result
-
getSubjects
@POST @Path("/grouper-ws/servicesRest/vG_E_SUF/subjects") public static WsGetSubjectsResults getSubjects(GrouperVersion clientVersion, String subjectId, String sourceId, WsRestGetSubjectsRequest wsRestGetSubjectsRequest) find subjects by id or search string. e.g. url: /v1_6_000/subjects/12345678 /v1_6_000/subjects
- Parameters:
clientVersion
- version of client, e.g. v1_6_000subjectId
- is the subjectId (optional)sourceId
- is the source id of the subject to search for (optional)wsRestGetSubjectsRequest
- is the request body converted to an object- Returns:
- the result
-
getSubjectsLite
public static WsGetSubjectsResults getSubjectsLite(GrouperVersion clientVersion, String subjectId, String sourceId, WsRestGetSubjectsLiteRequest wsRestGetSubjectsLiteRequest) find subjects by id or search string. e.g. url: /v1_6_000/subjects/12345678 /v1_6_000/subjects
- Parameters:
clientVersion
- version of client, e.g. v1_6_000subjectId
- is the subjectId (optional)sourceId
- is the source id of the subject to search for (optional)wsRestGetSubjectsLiteRequest
- is the request body converted to an object- Returns:
- the result
-
getAttributeAssignments
@POST @Path("/grouper-ws/servicesRest/vG_E_ABF/attributeAssignments") public static WsGetAttributeAssignmentsResults getAttributeAssignments(GrouperVersion clientVersion, WsRestGetAttributeAssignmentsRequest wsRestGetAttributesRequest) get attribute assignments rest- Parameters:
clientVersion
-wsRestGetAttributesRequest
-- Returns:
- the result
-
getAttributeAssignmentsLite
public static WsGetAttributeAssignmentsResults getAttributeAssignmentsLite(GrouperVersion clientVersion, WsRestGetAttributeAssignmentsLiteRequest wsRestGetAttributesLiteRequest) get attribute assignments rest for one owner (lite)- Parameters:
clientVersion
-wsRestGetAttributesLiteRequest
-- Returns:
- the results object
-
assignAttributeDefActions
@POST @Path("/grouper-ws/servicesRest/vA_D_ACF/attributeDefActions") public static WsAttributeDefAssignActionResults assignAttributeDefActions(GrouperVersion clientVersion, WsRestAssignAttributeDefActionsRequest wsRestAssignAttributeDefActionsRequest) assign actions to attribute def- Parameters:
clientVersion
-wsRestAssignAttributeDefActionsRequest
-- Returns:
- the result
-
getAttributeAssignActions
@POST @Path("/grouper-ws/servicesRest/vG_E_ABF/attributeAssignActions") public static WsGetAttributeAssignActionsResults getAttributeAssignActions(GrouperVersion clientVersion, WsRestGetAttributeAssignActionsRequest wsRestGetAttributeAssignActionsRequest) get attribute assign actions rest- Parameters:
clientVersion
-wsRestGetAttributeAssignActionsRequest
-- Returns:
- the result
-
getAttributeAssignActionsLite
public static WsGetAttributeAssignActionsResults getAttributeAssignActionsLite(GrouperVersion clientVersion, WsRestGetAttributeAssignActionsLiteRequest wsRestGetAttributeAssignActionsLiteRequest) get attribute assign actions rest for one attribute definition- Parameters:
clientVersion
-wsRestGetAttributeAssignActionsLiteRequest
-- Returns:
- the results object
-
assignAttributes
@POST @Path("/grouper-ws/servicesRest/vA_E_ATF/attributeAssignments") public static WsAssignAttributesResults assignAttributes(GrouperVersion clientVersion, WsRestAssignAttributesRequest wsRestAssignAttributesRequest) assign attributes rest- Parameters:
clientVersion
-wsRestAssignAttributesRequest
-- Returns:
- the result
-
assignAttributesLite
public static WsAssignAttributesLiteResults assignAttributesLite(GrouperVersion clientVersion, WsRestAssignAttributesLiteRequest wsRestAssignAttributesLiteRequest) assign attributes rest for one owner (lite)- Parameters:
clientVersion
-wsRestAssignAttributesLiteRequest
-- Returns:
- the results object
-
getPermissionAssignments
@POST @Path("/grouper-ws/servicesRest/vG_E_PAF/permissionAssignments") public static WsGetPermissionAssignmentsResults getPermissionAssignments(GrouperVersion clientVersion, WsRestGetPermissionAssignmentsRequest wsRestGetPermissionAssignmentsRequest) get permission assignments rest- Parameters:
clientVersion
-wsRestGetPermissionAssignmentsRequest
-- Returns:
- the result
-
getPermissionAssignmentsLite
public static WsGetPermissionAssignmentsResults getPermissionAssignmentsLite(GrouperVersion clientVersion, WsRestGetPermissionAssignmentsLiteRequest wsRestGetPermissionAssignmentsLiteRequest) get permission assignments rest for one owner (lite)- Parameters:
clientVersion
-wsRestGetPermissionAssignmentsLiteRequest
-- Returns:
- the results object
-
assignPermissions
@POST @Path("/grouper-ws/servicesRest/vA_H_PRF/permissionAssignments") public static WsAssignPermissionsResults assignPermissions(GrouperVersion clientVersion, WsRestAssignPermissionsRequest wsRestAssignPermissionsRequest) assign permissions rest- Parameters:
clientVersion
-wsRestAssignPermissionsRequest
-- Returns:
- the result
-
assignPermissionsLite
public static WsAssignPermissionsLiteResults assignPermissionsLite(GrouperVersion clientVersion, WsRestAssignPermissionsLiteRequest wsRestAssignPermissionsLiteRequest) assign attributes rest for one owner (lite)- Parameters:
clientVersion
-wsRestAssignPermissionsLiteRequest
-- Returns:
- the results object
-
attributeDefSave
@POST @Path("/grouper-ws/servicesRest/vA_L_SAF/attributeDefs") public static WsAttributeDefSaveResults attributeDefSave(GrouperVersion clientVersion, WsRestAttributeDefSaveRequest wsRestAttributeDefSaveRequest) save an AttributeDef or many (insert or update). Note, you cannot rename an existing AttributeDef.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestAttributeDefSaveRequest
-- Returns:
- the results
-
attributeDefSaveLite
public static WsAttributeDefSaveLiteResult attributeDefSaveLite(GrouperVersion clientVersion, String attributeDefLookupName, WsRestAttributeDefSaveLiteRequest wsRestAttributeDefSaveLiteRequest) save an AttributeDef (insert or update). Note you cannot currently move an existing AttributeDef.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestAttributeDefSaveLiteRequest
-attributeDefLookupName
-- Returns:
- the result of one attribute def save
-
attributeDefDelete
@POST @Path("/grouper-ws/servicesRest/vA_I_DEF/attributeDefs") public static WsAttributeDefDeleteResults attributeDefDelete(GrouperVersion clientVersion, WsRestAttributeDefDeleteRequest wsRestAttributeDefDeleteRequest) based on a submitted object of type WsRestAttributeDefDeleteRequest, delete the attributeDefs. e.g. url: /v1_3_000/attributeDefs
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestAttributeDefDeleteRequest
- is the request body converted to an object- Returns:
- the result
-
attributeDefDeleteLite
public static WsAttributeDefDeleteLiteResult attributeDefDeleteLite(GrouperVersion clientVersion, WsRestAttributeDefDeleteLiteRequest wsRestAttributeDefDeleteLiteRequest) - Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestAttributeDefDeleteLiteRequest
- is the request body converted to an object- Returns:
- the result
-
findAttributeDefs
@POST @Path("/grouper-ws/servicesRest/vF_A_DSF/attributeDefs") public static WsFindAttributeDefsResults findAttributeDefs(GrouperVersion clientVersion, WsRestFindAttributeDefsRequest wsRestFindAttributeDefsRequest) find an attribute def or attribute defs. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestFindAttributeDefsRequest
-- Returns:
- the attribute defs, or no attribute def if none found
-
findAttributeDefsLite
public static WsFindAttributeDefsResults findAttributeDefsLite(GrouperVersion clientVersion, WsRestFindAttributeDefsLiteRequest wsRestFindAttributeDefsLiteRequest) find an attribute def or attribute defs. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.- Parameters:
clientVersion
-wsRestFindAttributeDefsLiteRequest
-- Returns:
- the attribute defs, or no attribute def if none found
-
assignAttributeDefNameInheritance
@POST @Path("/grouper-ws/servicesRest/vA_D_ANF/attributeDefNames") public static WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritance(GrouperVersion clientVersion, WsRestAssignAttributeDefNameInheritanceRequest wsRestAssignAttributeDefNameInheritanceRequest) assign or unassign attribute def name permission inheritance- Parameters:
clientVersion
-wsRestAssignAttributeDefNameInheritanceRequest
-- Returns:
- the result
-
assignAttributeDefNameInheritanceLite
public static WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritanceLite(GrouperVersion clientVersion, WsRestAssignAttributeDefNameInheritanceLiteRequest wsRestAssignAttributeDefNameInheritanceLiteRequest) assign or unassign attribute def name permission inheritance- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestAssignAttributeDefNameInheritanceLiteRequest
-- Returns:
- the result
-
attributeDefNameDelete
@POST @Path("/grouper-ws/servicesRest/vA_J_DEF/attributeDefNames") public static WsAttributeDefNameDeleteResults attributeDefNameDelete(GrouperVersion clientVersion, WsRestAttributeDefNameDeleteRequest wsRestAttributeDefNameDeleteRequest) delete an AttributeDefName or many. Note, you cannot rename an existing AttributeDefName.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestAttributeDefNameDeleteRequest
-- Returns:
- the results
-
attributeDefNameDeleteLite
public static WsAttributeDefNameDeleteLiteResult attributeDefNameDeleteLite(GrouperVersion clientVersion, String attributeDefName, WsRestAttributeDefNameDeleteLiteRequest wsRestAttributeDefNameDeleteLiteRequest) delete an AttributeDefName- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000attributeDefName
-wsRestAttributeDefNameDeleteLiteRequest
-- Returns:
- the result of one member add
-
attributeDefNameSave
@POST @Path("/grouper-ws/servicesRest/vA_K_SAF/attributeDefNames") public static WsAttributeDefNameSaveResults attributeDefNameSave(GrouperVersion clientVersion, WsRestAttributeDefNameSaveRequest wsRestAttributeDefNameSaveRequest) save an AttributeDefName or many (insert or update). Note, you cannot rename an existing AttributeDefName.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestAttributeDefNameSaveRequest
-- Returns:
- the results
-
attributeDefNameSaveLite
public static WsAttributeDefNameSaveLiteResult attributeDefNameSaveLite(GrouperVersion clientVersion, String attributeDefNameLookupName, WsRestAttributeDefNameSaveLiteRequest wsRestAttributeDefNameSaveLiteRequest) save an AttributeDefName (insert or update). Note you cannot currently move an existing AttributeDefName.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestAttributeDefNameSaveLiteRequest
-attributeDefNameLookupName
-- Returns:
- the result of one member add
-
findAttributeDefNames
@POST @Path("/grouper-ws/servicesRest/vF_A_DNF/attributeDefNames") public static WsFindAttributeDefNamesResults findAttributeDefNames(GrouperVersion clientVersion, WsRestFindAttributeDefNamesRequest wsRestFindAttributeDefNamesRequest) find an attribute def name or attribute def names. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestFindAttributeDefNamesRequest
-- Returns:
- the attribute def names, or no attribute def names if none found
-
findAttributeDefNamesLite
public static WsFindAttributeDefNamesResults findAttributeDefNamesLite(GrouperVersion clientVersion, String attributeDefNameName, WsRestFindAttributeDefNamesLiteRequest wsRestFindAttributeDefNamesLiteRequest) find an attribute def name or attribute def names. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.- Parameters:
clientVersion
-attributeDefNameName
- if in urlwsRestFindAttributeDefNamesLiteRequest
-- Returns:
- the attribute def names, or no attribute def names if none found
-
assignAttributesBatch
@POST @Path("/grouper-ws/servicesRest/vA_E_ATG/attributeAssignments") public static WsAssignAttributesBatchResults assignAttributesBatch(GrouperVersion clientVersion, WsRestAssignAttributesBatchRequest wsRestAssignAttributesBatchRequest) assign attributes batch rest- Parameters:
clientVersion
-wsRestAssignAttributesBatchRequest
-- Returns:
- the result
-
sendMessage
@POST @Path("/grouper-ws/servicesRest/vS_E_MES/messaging") public static WsMessageResults sendMessage(GrouperVersion clientVersion, WsRestSendMessageRequest wsRestSendMessageRequest) send message(s)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestSendMessageRequest
-- Returns:
- the messages sent
-
receiveMessage
@POST @Path("/grouper-ws/servicesRest/vR_C_MES/messaging") public static WsMessageResults receiveMessage(GrouperVersion clientVersion, WsRestReceiveMessageRequest wsRestReceiveMessageRequest) receive message(s)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestReceiveMessageRequest
-- Returns:
- the messages received
-
acknowledgeMessages
@POST @Path("/grouper-ws/servicesRest/vA_A_MAF/messaging") public static WsMessageAcknowledgeResults acknowledgeMessages(GrouperVersion clientVersion, WsRestAcknowledgeMessageRequest wsRestMessageAcknowledgeRequest) acknowledge message(s)- Parameters:
clientVersion
- is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000wsRestMessageAcknowledgeRequest
-- Returns:
- the processed messages
-
findExternalSubjects
@POST @Path("/grouper-ws/servicesRest/vF_E_SUB/externalSubjects") public static WsFindExternalSubjectsResults findExternalSubjects(GrouperVersion clientVersion, WsRestFindExternalSubjectsRequest wsRestFindExternalSubjectsRequest) based on an external subject query, get the external subjects
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestFindExternalSubjectsRequest
- is the request body converted to an object- Returns:
- the results
-
externalSubjectDelete
@POST @Path("/grouper-ws/servicesRest/vE_S_DEL/externalSubjects") public static WsExternalSubjectDeleteResults externalSubjectDelete(GrouperVersion clientVersion, WsRestExternalSubjectDeleteRequest wsRestExternalSubjectDeleteRequest) based on a submitted object of type WsRestExternalSubjectDeleteRequest, delete the external subjects. e.g. url: /v1_3_000/externalSubjects
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestExternalSubjectDeleteRequest
- is the request body converted to an object- Returns:
- the result
-
externalSubjectSave
@POST @Path("/grouper-ws/servicesRest/vE_S_SAV/externalSubjects") public static WsExternalSubjectSaveResults externalSubjectSave(GrouperVersion clientVersion, WsRestExternalSubjectSaveRequest wsRestExternalSubjectSaveRequest) based on a submitted object of type WsRestExternalSubjectSaveRequest, save external subjects. e.g. url: /v1_3_000/externalSubjects
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestExternalSubjectSaveRequest
- is the request body converted to an object- Returns:
- the result
-
getAuditEntriesLite
public static WsGetAuditEntriesResults getAuditEntriesLite(GrouperVersion clientVersion, WsRestGetAuditEntriesLiteRequest wsRestGetAuditEntriesLiteRequest) based on query, get audits
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestGetAuditEntriesLiteRequest
- is the request body converted to an object- Returns:
- the results
-
getAuditEntries
@POST @Path("/grouper-ws/servicesRest/vG_E_AEF/audits") public static WsGetAuditEntriesResults getAuditEntries(GrouperVersion clientVersion, WsRestGetAuditEntriesRequest wsRestGetAuditEntriesRequest) based on query, get audits
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestGetAuditEntriesRequest
- is the request body converted to an object- Returns:
- the results
-
executeGshTemplate
@POST @Path("/grouper-ws/servicesRest/vE_G_TEM") public static WsGshTemplateExecResult executeGshTemplate(GrouperVersion clientVersion, WsRestGshTemplateExecRequest wsRestGshTemplateExecRequest) based on a submitted object of type WsRestGshTemplateExecRequest, execute gsh template /v1_3_000/gshTemplateExec
- Parameters:
clientVersion
- version of client, e.g. v1_3_000wsRestGshTemplateExecRequest
- is the request body converted to an object- Returns:
- the result
-