com.atlassian.crowd.plugin.rest.service.resource.saml

Class SamlConfigurationResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.saml.SamlConfigurationResource

@Path(value="/samlconfig")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public class SamlConfigurationResource
extends Object

Resource for SSO SAML configuration.

Since:

3.4.0

Constructor Summary

Constructors

Constructor and Description
SamlConfigurationResource(SamlConfigurationController samlConfigurationController)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	findDirectoryMappingsMismatch(long applicationId) Compares the directory mappings of application with crowd application
ApplicationSamlConfigurationRestEntity	getConfiguration(long applicationId) Returns SAML configuration.
javax.ws.rs.core.Response	getIdpMetadata() Returns Identity provider's metadata
javax.ws.rs.core.Response	getSamlConfiguration() Returns the global SAML configuration
ApplicationSamlConfigurationRestEntity	parseApplicationMetadata(com.atlassian.plugins.rest.common.multipart.FilePart file, javax.servlet.http.HttpServletRequest request) Parses SAML configuration.
ApplicationSamlConfigurationRestEntity	parseApplicationMetadata(InputStream inputStream) Parses SAML configuration.
javax.ws.rs.core.Response	resetSamlConfiguration() Replaces the private key/certificate pair used for signing/verifying assertions with a new one.
javax.ws.rs.core.Response	updateApplicationConfiguration(long applicationId, ApplicationSamlConfigurationRestEntity config) Updates SAML configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SamlConfigurationResource

public SamlConfigurationResource(SamlConfigurationController samlConfigurationController)

Method Detail

resetSamlConfiguration

@POST
 @Path(value="/reset-certificates")
public javax.ws.rs.core.Response resetSamlConfiguration()

Replaces the private key/certificate pair used for signing/verifying assertions with a new one.

Returns:

@return global SAML configuration including the newly generated private key/certificate pair

getSamlConfiguration

@GET
public javax.ws.rs.core.Response getSamlConfiguration()

Returns the global SAML configuration

Returns:

the global SAML configuration

getConfiguration

@Path(value="application/{applicationId}")
 @GET
public ApplicationSamlConfigurationRestEntity getConfiguration(@PathParam(value="applicationId")
                                                                                                                long applicationId)
                                                                                                         throws ApplicationNotFoundException

Returns SAML configuration.

Parameters:

applicationId - application id

Throws:

ApplicationNotFoundException

updateApplicationConfiguration

@Path(value="application/{applicationId}")
 @POST
public javax.ws.rs.core.Response updateApplicationConfiguration(@PathParam(value="applicationId")
                                                                                                                  long applicationId,
                                                                                                                  ApplicationSamlConfigurationRestEntity config)
                                                                                                           throws ApplicationNotFoundException,
                                                                                                                  OperationFailedException,
                                                                                                                  InvalidApplicationSamlConfigurationException

Updates SAML configuration.

Parameters:

applicationId - application id

Throws:

ApplicationNotFoundException

OperationFailedException

InvalidApplicationSamlConfigurationException

getIdpMetadata

@Path(value="/idp/metadata")
 @GET
public javax.ws.rs.core.Response getIdpMetadata()
                                                                            throws InvalidGlobalSamlConfigurationException

Returns Identity provider's metadata

Throws:

InvalidGlobalSamlConfigurationException

parseApplicationMetadata

@Path(value="application/parse_metadata")
 @Consumes(value="application/octet-stream")
 @POST
public ApplicationSamlConfigurationRestEntity parseApplicationMetadata(InputStream inputStream)

Parses SAML configuration.

See Also:

Metadata for SAML

parseApplicationMetadata

@Path(value="application/parse_metadata_multipart")
 @Consumes(value="multipart/form-data")
 @POST
public ApplicationSamlConfigurationRestEntity parseApplicationMetadata(com.atlassian.plugins.rest.common.multipart.FilePart file,
                                                                                                                                                                          @Context
                                                                                                                                                                          javax.servlet.http.HttpServletRequest request)
                                                                                                                                                                   throws IOException

Parses SAML configuration.

Throws:

IOException

See Also:

Metadata for SAML

findDirectoryMappingsMismatch

@Path(value="application/{applicationId}/directory-mapping-mismatch")
 @GET
public javax.ws.rs.core.Response findDirectoryMappingsMismatch(@PathParam(value="applicationId")
                                                                                                                                           long applicationId)
                                                                                                                                    throws Exception

Compares the directory mappings of application with crowd application

Throws:

Exception

See Also:

Metadata for SAML