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

Interface OIDCClientService

All Superinterfaces:

JAXRSService

@Path(value="oidcclient/clients")
public interface OIDCClientService
extends JAXRSService

REST operations for OpenID Connect Clients.

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
OIDCLoginRequestTO	createLoginRequest(String redirectURI, String op) Generates OpenID Connect authentication request for the Provider matching the provided op.
OIDCLogoutRequestTO	createLogoutRequest(String op) Returns the endSession endpoint for the provided op.
OIDCLoginResponseTO	login(String redirectURI, String authorizationCode, String op) Uses the provided authorization code to go through the OpenID Connect tokens process and finally creates JWT for the matching user, if found.

Method Detail

createLoginRequest

@POST
 @Path(value="loginRequest")
 @Produces(value={"application/json","application/yaml","application/xml"})
OIDCLoginRequestTO createLoginRequest(@QueryParam(value="redirect_uri")
                                                                                                                                                     String redirectURI,
                                                                                                                                                     @QueryParam(value="op")
                                                                                                                                                     String op)

Generates OpenID Connect authentication request for the Provider matching the provided op.

Parameters:

redirectURI - redirect URI

op - OpenID Connect Provider

Returns:

OpenID Connect authentication request

login

@POST
 @Path(value="login")
 @Produces(value={"application/json","application/yaml","application/xml"})
OIDCLoginResponseTO login(@QueryParam(value="redirect_uri")
                                                                                                                                  String redirectURI,
                                                                                                                                  @QueryParam(value="authorizationCode")
                                                                                                                                  String authorizationCode,
                                                                                                                                  @QueryParam(value="op")
                                                                                                                                  String op)

Uses the provided authorization code to go through the OpenID Connect tokens process and finally creates JWT for the matching user, if found.

Parameters:

redirectURI - redirect URI

authorizationCode - authorization code generated by the remote OpenID Connect Provider

op - OpenID Connect Provider

Returns:

JWT for the matching user plus attributes returned in the response

createLogoutRequest

@POST
 @Path(value="logout")
 @Produces(value={"application/json","application/yaml","application/xml"})
OIDCLogoutRequestTO createLogoutRequest(@QueryParam(value="op")
                                                                                                                                                 String op)

Returns the endSession endpoint for the provided op.

Parameters:

op - OpenID Connect Provider

Returns:

endSession endpoint for the provided op