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

Interface AccessTokenService

All Superinterfaces:

JAXRSService

@Path(value="accessTokens")
public interface AccessTokenService
extends JAXRSService

REST operations for access tokens.

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
void	delete(String key) Invalidates the access token matching the provided key.
PagedResult<AccessTokenTO>	list(AccessTokenQuery query) Returns a paged list of existing access tokens matching the given query.
javax.ws.rs.core.Response	login() Returns an empty response bearing the X-Syncope-Token header value, in case of successful authentication.
void	logout() Invalidates the access token of the requesting user.
javax.ws.rs.core.Response	refresh() Returns an empty response bearing the X-Syncope-Token header value, with extended lifetime.

Method Detail

login

@POST
 @Path(value="login")
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response login()

Returns an empty response bearing the X-Syncope-Token header value, in case of successful authentication. The provided value is a signed JSON Web Token.

Returns:

empty response bearing the X-Syncope-Token header value, in case of successful authentication

refresh

@POST
 @Path(value="refresh")
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response refresh()

Returns an empty response bearing the X-Syncope-Token header value, with extended lifetime. The provided value is a signed JSON Web Token.

Returns:

an empty response bearing the X-Syncope-Token header value, with extended lifetime

logout

@POST
 @Path(value="logout")
 @Produces(value={"application/json","application/yaml","application/xml"})
void logout()

Invalidates the access token of the requesting user.

list

@GET
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
PagedResult<AccessTokenTO> list(@BeanParam
                                                                                                                                                                                             AccessTokenQuery query)

Returns a paged list of existing access tokens matching the given query.

Parameters:

query - query conditions

Returns:

paged list of existing access tokens matching the given query

delete

@DELETE
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void delete(@PathParam(value="key")
                                                                                                                      String key)

Invalidates the access token matching the provided key.

Parameters:

key - access token key