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

Interface AuthProfileService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

AuthProfileServiceImpl

@Path("authProfiles")
public interface AuthProfileService
extends JAXRSService

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 Type	Method	Description
Response	create(@NotNull AuthProfileTO authProfileTO)	Create a new auth profile.
void	delete(@NotNull String key)	Deletes the auth profile matching the provided if key, if found.
AuthProfileTO	read(@NotNull String key)	Returns the auth profile matching the provided if key, if found.
PagedResult<AuthProfileTO>	search(AuthProfileQuery query)	Returns a paged list of all AuthProfiles.
void	update(@NotNull AuthProfileTO authProfileTO)	Updates the auth profile matching the provided if key, if found.

Method Details

search

@GET
@Produces({"application/json","application/yaml","application/xml"})
PagedResult<AuthProfileTO> search(@BeanParam
 AuthProfileQuery query)

Returns a paged list of all AuthProfiles.

Parameters:

query - query conditions

Returns:

list of all AuthProfiles.

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