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

Interface SAML2IdPService

All Superinterfaces:

JAXRSService

@Path(value="saml2sp/identityProviders")
public interface SAML2IdPService
extends JAXRSService

REST operations for SAML 2.0 Identity Providers.

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) Deletes the SAML 2.0 Identity Provider with matching entityID.
Set<String>	getActionsClasses() Returns the list of available SAML2IdPActions implementations.
Set<String>	getRequestedAuthnContextProviderClasses() Returns the list of available RequestedAuthnContextProviders implementations.
javax.ws.rs.core.Response	importFromMetadata(InputStream input) Imports the SAML 2.0 Identity Provider definitions available in the provided XML metadata.
List<SAML2IdPTO>	list() Returns a list of all defined SAML 2.0 Identity Providers.
SAML2IdPTO	read(String key) Returns the SAML 2.0 Identity Provider with matching entityID, if available.
void	update(SAML2IdPTO saml2IdpTO) Updates the SAML 2.0 Identity Provider with matching entityID.

Method Detail

getActionsClasses

@GET
 @Path(value="actionsClasses")
 @Produces(value="application/json")
Set<String> getActionsClasses()

Returns the list of available SAML2IdPActions implementations.

Returns:

the list of available SAML2IdPActions implementations

getRequestedAuthnContextProviderClasses

@GET
 @Path(value="requestedAuthnContextProviders")
 @Produces(value="application/json")
Set<String> getRequestedAuthnContextProviderClasses()

Returns the list of available RequestedAuthnContextProviders implementations.

Returns:

the list of available RequestedAuthnContextProviders implementations

list

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
List<SAML2IdPTO> list()

Returns a list of all defined SAML 2.0 Identity Providers.

Returns:

list of all defined SAML 2.0 Identity Providers

read

@GET
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
SAML2IdPTO read(@PathParam(value="key")
                                                                                                                       String key)

Returns the SAML 2.0 Identity Provider with matching entityID, if available.

Parameters:

key - SAML 2.0 Identity Provider's entityID

Returns:

SAML 2.0 Identity Provider with matching entityID, if available

importFromMetadata

@POST
 @Consumes(value="application/xml")
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response importFromMetadata(@NotNull
                                                                                                                                                                   InputStream input)

Imports the SAML 2.0 Identity Provider definitions available in the provided XML metadata.

Parameters:

input - XML metadata

Returns:

the entityID values for all imported SAML 2.0 Identity Providers

update

@PUT
 @Path(value="{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void update(@NotNull
                                                                                                                                                                                               SAML2IdPTO saml2IdpTO)

Updates the SAML 2.0 Identity Provider with matching entityID.

Parameters:

saml2IdpTO - idp configuration to be stored

delete

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

Deletes the SAML 2.0 Identity Provider with matching entityID.

Parameters:

key - SAML 2.0 Identity Provider's entityID