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

Interface SAML2SPService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

SAML2SPServiceImpl

@Path(value="saml2sp/serviceProvider")
public interface SAML2SPService
extends JAXRSService

REST operations for the provided SAML 2.0 Service Provider.

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_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
SAML2RequestTO	createLoginRequest(String spEntityID, String idpEntityID) Generates SAML 2.0 authentication request for the IdP matching the provided entity ID.
SAML2RequestTO	createLogoutRequest(String spEntityID) Generates SAML 2.0 logout request for the IdP matching the requesting access token.
javax.ws.rs.core.Response	getMetadata(String spEntityID, String urlContext) Returns the XML metadata for the provided SAML 2.0 Service Provider.
SAML2LoginResponseTO	validateLoginResponse(SAML2ReceivedResponseTO response) Validates the received SAML 2.0 authentication response and creates JWT for the matching user, if found.
void	validateLogoutResponse(SAML2ReceivedResponseTO response) Validates the received SAML 2.0 logout response.

Method Detail

getMetadata

@GET
 @Produces(value="application/xml")
javax.ws.rs.core.Response getMetadata(@QueryParam(value="spEntityID")
                                                                               String spEntityID,
                                                                               @QueryParam(value="urlContext")
                                                                               String urlContext)

Returns the XML metadata for the provided SAML 2.0 Service Provider.

Parameters:

spEntityID - SAML 2.0 SP entity ID.

urlContext - SAML 2.0 SP agent URL context

Returns:

XML metadata for the provided SAML 2.0 Service Provider

createLoginRequest

@POST
 @Path(value="loginRequest")
 @Produces(value={"application/json","application/yaml","application/xml"})
SAML2RequestTO createLoginRequest(@QueryParam(value="spEntityID")
                                                                                                                                                 String spEntityID,
                                                                                                                                                 @QueryParam(value="idpEntityID")
                                                                                                                                                 String idpEntityID)

Generates SAML 2.0 authentication request for the IdP matching the provided entity ID.

Parameters:

spEntityID - SAML 2.0 SP entity ID.

idpEntityID - SAML 2.0 IdP entity ID.

Returns:

SAML 2.0 authentication request

validateLoginResponse

@POST
 @Path(value="loginResponse")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
SAML2LoginResponseTO validateLoginResponse(SAML2ReceivedResponseTO response)

Validates the received SAML 2.0 authentication response and creates JWT for the matching user, if found.

Parameters:

response - SAML response and relay state

Returns:

JWT for the matching user plus attributes returned in the response

createLogoutRequest

@POST
 @Path(value="logoutRequest")
 @Produces(value={"application/json","application/yaml","application/xml"})
SAML2RequestTO createLogoutRequest(@QueryParam(value="spEntityID")
                                                                                                                                                   String spEntityID)

Generates SAML 2.0 logout request for the IdP matching the requesting access token.

Parameters:

spEntityID - SAML 2.0 SP entity ID.

Returns:

SAML 2.0 logout request

validateLogoutResponse

@POST
 @Path(value="logoutResponse")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void validateLogoutResponse(SAML2ReceivedResponseTO response)

Validates the received SAML 2.0 logout response.

Parameters:

response - SAML response and relay state