org.apache.syncope.common.rest.api.service

Interface GroupService

All Superinterfaces:

AnyService<GroupTO,GroupPatch>, JAXRSService

@Path(value="groups")
public interface GroupService
extends AnyService<GroupTO,GroupPatch>

REST operations for groups.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
ExecTO	bulkMembersAction(String key, BulkMembersActionType actionType) (De)provision all members of the given group from / onto all the resources associated to it.
List<GroupTO>	own() This method is similar to read() but uses different authentication handling to ensure that a user can read his own groups.
TypeExtensionTO	readTypeExtension(String key, String anyTypeKey) Extracts type extension information, for the provided group and any type.

Methods inherited from interface org.apache.syncope.common.rest.api.service.AnyService

associate, bulk, create, deassociate, delete, delete, read, read, read, search, update, update, update

Method Detail

own

@GET
 @Path(value="own")
 @Produces(value={"application/json","application/xml"})
List<GroupTO> own()

This method is similar to read() but uses different authentication handling to ensure that a user can read his own groups.

Returns:

own groups

readTypeExtension

@GET
 @Path(value="{key}/{anyTypeKey}/typeExtension")
 @Produces(value={"application/json","application/xml"})
TypeExtensionTO readTypeExtension(@NotNull @PathParam(value="key")
                                                                                                                                                 String key,
                                                                                                                                                 @NotNull @PathParam(value="anyTypeKey")
                                                                                                                                                 String anyTypeKey)

Extracts type extension information, for the provided group and any type.

Parameters:

key - group key

anyTypeKey - any type key

Returns:

type extension information, for the provided group and any type

bulkMembersAction

@POST
 @Path(value="{key}/members/{actionType}")
ExecTO bulkMembersAction(@NotNull @PathParam(value="key")
                                                                          String key,
                                                                          @NotNull @PathParam(value="actionType")
                                                                          BulkMembersActionType actionType)

(De)provision all members of the given group from / onto all the resources associated to it.

Parameters:

key - group key

actionType - action type to perform on all group members

Returns:

execution report for the task generated on purpose