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

Interface SyncopeService

All Superinterfaces:

JAXRSService

@Path(value="")
public interface SyncopeService
extends JAXRSService

General info about this Apache Syncope deployment.

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
NumbersInfo	numbers() Provides some numbers about the managed entities (users, groups, any objects...).
PlatformInfo	platform() Provides information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...).
TypeExtensionTO	readUserTypeExtension(String groupName) Extracts User type extension information, for the provided group.
PagedResult<GroupTO>	searchAssignableGroups(String realm, String term, int page, int size) Returns the list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm.
SystemInfo	system() Provides information about the underlying system (Operating System, CPU / memory usage, ...).

Method Detail

platform

@GET
 @Path(value="/platform")
 @Produces(value={"application/json","application/yaml","application/xml"})
PlatformInfo platform()

Provides information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...).

Returns:

information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...)

system

@GET
 @Path(value="/system")
 @Produces(value={"application/json","application/yaml","application/xml"})
SystemInfo system()

Provides information about the underlying system (Operating System, CPU / memory usage, ...).

Returns:

information about the underlying system (Operating System, CPU / memory usage, ...)

numbers

@GET
 @Path(value="/numbers")
 @Produces(value={"application/json","application/yaml","application/xml"})
NumbersInfo numbers()

Provides some numbers about the managed entities (users, groups, any objects...).

Returns:

some numbers about the managed entities (users, groups, any objects...)

searchAssignableGroups

@POST
 @Path(value="/assignableGroups/{realm:.*}")
 @Produces(value={"application/json","application/yaml","application/xml"})
PagedResult<GroupTO> searchAssignableGroups(@NotNull @PathParam(value="realm")
                                                                                                                                                                           String realm,
                                                                                                                                                                           @QueryParam(value="term")
                                                                                                                                                                           String term,
                                                                                                                                                                           @Min(value=1L) @QueryParam(value="page") @DefaultValue(value="1")
                                                                                                                                                                           int page,
                                                                                                                                                                           @Min(value=1L) @QueryParam(value="size") @DefaultValue(value="25")
                                                                                                                                                                           int size)

Returns the list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm.

Parameters:

term - groups search term

realm - of the User and Any Objects assignable to the returned Groups

page - search page

size - search page size

Returns:

list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm

readUserTypeExtension

@GET
 @Path(value="/userTypeExtension/{groupName}")
 @Produces(value={"application/json","application/yaml","application/xml"})
TypeExtensionTO readUserTypeExtension(@NotNull @PathParam(value="groupName")
                                                                                                                                                                      String groupName)

Extracts User type extension information, for the provided group.

Parameters:

groupName - group name

Returns:

User type extension information, for the provided group