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

Interface OIDCC4UIProviderService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

OIDCC4UIProviderServiceImpl

@Path("oidcc4ui/providers")
public interface OIDCC4UIProviderService
extends JAXRSService

REST operations for OpenID Connect Providers.

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

Method Summary

Modifier and Type	Method	Description
Response	create(OIDCC4UIProviderTO oidcProviderTO)	Creates a new OIDC Provider.
Response	createFromDiscovery(OIDCC4UIProviderTO oidcProviderTO)	Creates a new OIDC Provider by using its Discovery Document.
void	delete(String key)	Deletes the OIDC Provider with matching key.
List<OIDCC4UIProviderTO>	list()	Returns a list of all defined OIDC Providers.
OIDCC4UIProviderTO	read(String key)	Returns the OIDC Provider with matching key, if available.
void	update(@NotNull OIDCC4UIProviderTO oidcProviderTO)	Updates the OIDC Provider with matching key.

Method Details

list

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

Returns a list of all defined OIDC Providers.

Returns:

list of all defined OIDC Providers

read

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

Returns the OIDC Provider with matching key, if available.

Parameters:

key - OIDC Provider's key

Returns:

OIDC Providers with matching key, if available

create

@POST
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
Response create(OIDCC4UIProviderTO oidcProviderTO)

Creates a new OIDC Provider.

Parameters:

oidcProviderTO - OpenID Connect Provider configuration to be stored

Returns:

Response object featuring Location header of created OIDC Provider

createFromDiscovery

@POST
@Path("fromDiscovery")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
Response createFromDiscovery(OIDCC4UIProviderTO oidcProviderTO)

Creates a new OIDC Provider by using its Discovery Document.

Parameters:

oidcProviderTO - OpenID Connect Provider configuration to be stored

Returns:

Response object featuring Location header of created OIDC Provider

update

@PUT
@Path("{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
void update(@NotNull
 @NotNull OIDCC4UIProviderTO oidcProviderTO)

Updates the OIDC Provider with matching key.

Parameters:

oidcProviderTO - OpenID Connect Provider configuration to be stored

delete

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

Deletes the OIDC Provider with matching key.

Parameters:

key - OIDC Provider key