Module org.elasticsearch.security
Class RestSamlPrepareAuthenticationAction
java.lang.Object
org.elasticsearch.rest.BaseRestHandler
org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler
org.elasticsearch.xpack.security.rest.action.saml.SamlBaseRestHandler
org.elasticsearch.xpack.security.rest.action.saml.RestSamlPrepareAuthenticationAction
- All Implemented Interfaces:
RestHandler
Generates a SAML authentication request (
<AuthnRequest>) based on the provided
parameters.
The request is returned in the REST response, and the REST client should make it available
to the browser.-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler
BaseRestHandler.RequestBodyChunkConsumer, BaseRestHandler.RestChannelConsumerNested classes/interfaces inherited from interface org.elasticsearch.rest.RestHandler
RestHandler.Route -
Field Summary
Fields inherited from class org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler
CLIENT_AUTHENTICATION_PARSER, licenseState, settingsFields inherited from class org.elasticsearch.rest.BaseRestHandler
MULTI_ALLOW_EXPLICIT_INDEX -
Constructor Summary
ConstructorsConstructorDescriptionRestSamlPrepareAuthenticationAction(Settings settings, XPackLicenseState licenseState) -
Method Summary
Modifier and TypeMethodDescriptiongetName()innerPrepareRequest(RestRequest request, NodeClient client) Implementers should implement this method as they normally would forBaseRestHandler.prepareRequest(RestRequest, NodeClient)and ensure that all request parameters are consumed prior to returning a value.routes()Methods inherited from class org.elasticsearch.xpack.security.rest.action.saml.SamlBaseRestHandler
innerCheckFeatureAvailableMethods inherited from class org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler
checkFeatureAvailable, getSecureString, prepareRequestMethods inherited from class org.elasticsearch.rest.BaseRestHandler
getUsageCount, handleRequest, responseParams, responseParams, unrecognizedMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.rest.RestHandler
allowSystemIndexAccessByDefault, allSupportedParameters, canTripCircuitBreaker, getConcreteRestHandler, getServerlessScope, mediaTypesValid, supportedCapabilities, supportedQueryParameters, supportsBulkContent
-
Constructor Details
-
RestSamlPrepareAuthenticationAction
-
-
Method Details
-
routes
- Specified by:
routesin interfaceRestHandler- Specified by:
routesin classBaseRestHandler
-
getName
- Specified by:
getNamein interfaceRestHandler- Specified by:
getNamein classBaseRestHandler
-
innerPrepareRequest
public BaseRestHandler.RestChannelConsumer innerPrepareRequest(RestRequest request, NodeClient client) throws IOException Description copied from class:SecurityBaseRestHandlerImplementers should implement this method as they normally would forBaseRestHandler.prepareRequest(RestRequest, NodeClient)and ensure that all request parameters are consumed prior to returning a value. This method is executed only if the check fromSecurityBaseRestHandler.checkFeatureAvailable(RestRequest)passes.- Specified by:
innerPrepareRequestin classSecurityBaseRestHandler- Throws:
IOException
-