@Path(value="accessTokens") public interface AccessTokenService extends JAXRSService
CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER
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.
|
@POST @Path(value="login") @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response login()
@POST @Path(value="refresh") @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response refresh()
@POST @Path(value="logout") @Produces(value={"application/json","application/yaml","application/xml"}) void logout()
@GET @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value={"application/json","application/yaml","application/xml"}) PagedResult<AccessTokenTO> list(@BeanParam AccessTokenQuery query)
query
- query conditions@DELETE @Path(value="{key}") @Produces(value={"application/json","application/yaml","application/xml"}) void delete(@PathParam(value="key") String key)
key
- access token keyCopyright © 2010–2023 The Apache Software Foundation. All rights reserved.