Interface AuthProfileService
- All Superinterfaces:
JAXRSService
- All Known Implementing Classes:
AuthProfileServiceImpl
REST operations for Auth profiles.
-
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
Modifier and TypeMethodDescriptioncreate
(@NotNull AuthProfileTO authProfileTO) Create a new auth profile.void
Deletes the auth profile matching the provided if key, if found.list
(@jakarta.validation.constraints.Min(1L) int page, @jakarta.validation.constraints.Min(1L) int size) Returns the paginated list of existing auth profiles.Returns the auth profile matching the provided if key, if found.void
update
(@NotNull AuthProfileTO authProfileTO) Updates the auth profile matching the provided if key, if found.
-
Method Details
-
list
@GET @Produces({"application/json","application/yaml","application/xml"}) PagedResult<AuthProfileTO> list(@Min(1L) @QueryParam("page") @DefaultValue("1") @jakarta.validation.constraints.Min(1L) int page, @Min(1L) @QueryParam("size") @DefaultValue("25") @jakarta.validation.constraints.Min(1L) int size) Returns the paginated list of existing auth profiles.- Parameters:
page
- search pagesize
- search page size- Returns:
- the paginated list of existing auth profiles
-
read
@GET @Path("{key}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) AuthProfileTO read(@NotNull @PathParam("key") @NotNull String key) Returns the auth profile matching the provided if key, if found.- Parameters:
key
- auth profile key- Returns:
- auth profile matching the provided if key, if found
-
create
@POST @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) Response create(@NotNull @NotNull AuthProfileTO authProfileTO) Create a new auth profile.- Parameters:
authProfileTO
- auth profile to create- Returns:
- Response object featuring Location header of created client app
-
update
@PUT @Path("{key}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) void update(@NotNull @NotNull AuthProfileTO authProfileTO) Updates the auth profile matching the provided if key, if found.- Parameters:
authProfileTO
- auth profile
-
delete
@DELETE @Path("{key}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam("key") @NotNull String key) Deletes the auth profile matching the provided if key, if found.- Parameters:
key
- auth profile key
-