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

Interface AuthProfileSelfService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

AuthProfileSelfServiceImpl

@Path("authProfiles/self")
public interface AuthProfileSelfService
extends JAXRSService

REST operations for Auth profile self-management.

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
void	delete()	Deletes the auth profile matching the user making the service call, if found.
AuthProfileTO	read()	Returns the auth profile matching the user making the service call, if found.
void	update(@NotNull AuthProfileTO authProfileTO)	Updates the auth profile matching the user making the service call, if found.

Method Details

read

@GET
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
AuthProfileTO read()

Returns the auth profile matching the user making the service call, if found.

Returns:

auth profile matching the user making the service call, if found

update

@PUT
@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 user making the service call, if found.

Parameters:

authProfileTO - auth profile

delete

@DELETE
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
void delete()

Deletes the auth profile matching the user making the service call, if found.