Interface SyncopeService
-
- All Superinterfaces:
JAXRSService
- All Known Implementing Classes:
SyncopeServiceImpl
@Path("") 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
CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description javax.ws.rs.core.Response
batch()
Gets batch results, in case asynchronous was requested.javax.ws.rs.core.Response
batch(InputStream input)
Requests for batch execution.javax.ws.rs.core.Response
exportInternalStorageContent(int tableThreshold)
Exports internal storage content as downloadable XML file.TypeExtensionTO
readUserTypeExtension(@NotNull String groupName)
Extracts User type extension information, for the provided group.PagedResult<GroupTO>
searchAssignableGroups(@NotNull String realm, String term, @javax.validation.constraints.Min(1L) int page, @javax.validation.constraints.Min(1L) int size)
Returns the list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm.
-
-
-
Method Detail
-
batch
@POST @Path("/batch") @Consumes("multipart/mixed") @Produces("multipart/mixed") javax.ws.rs.core.Response batch(InputStream input)
Requests for batch execution.- Parameters:
input
- batch request- Returns:
- batch results returned as Response entity, in case no 'Prefer: respond-async' was specified
-
batch
@GET @Path("/batch") @Produces("multipart/mixed") javax.ws.rs.core.Response batch()
Gets batch results, in case asynchronous was requested.- Returns:
- batch results as Response entity
-
searchAssignableGroups
@POST @Path("/assignableGroups/{realm:.*}") @Produces({"application/json","application/yaml","application/xml"}) PagedResult<GroupTO> searchAssignableGroups(@NotNull @PathParam("realm") @NotNull String realm, @QueryParam("term") String term, @Min(1L) @QueryParam("page") @DefaultValue("1") @javax.validation.constraints.Min(1L) int page, @Min(1L) @QueryParam("size") @DefaultValue("25") @javax.validation.constraints.Min(1L) 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 termrealm
- of the User and Any Objects assignable to the returned Groupspage
- search pagesize
- 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("/userTypeExtension/{groupName}") @Produces({"application/json","application/yaml","application/xml"}) TypeExtensionTO readUserTypeExtension(@NotNull @PathParam("groupName") @NotNull String groupName)
Extracts User type extension information, for the provided group.- Parameters:
groupName
- group name- Returns:
- User type extension information, for the provided group
-
exportInternalStorageContent
@GET @Path("internalStorage/stream") javax.ws.rs.core.Response exportInternalStorageContent(@QueryParam("tableThreshold") @DefaultValue("100") int tableThreshold)
Exports internal storage content as downloadable XML file.- Parameters:
tableThreshold
- the maximum number of rows to take for each table of internal storage- Returns:
- internal storage content as downloadable XML file
-
-