It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Available authentication methods Initiate SAML protocol »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.2] ›RESTful API ›API reference ›Authentication

SAML callback

edit

SAML callback

edit

Accepts a callback request from an identity provider and authenticates the user.

Request

edit

POST /api/v1/users/auth/saml/_callback

Form Parameters

edit
Name Type Required Description

RelayState

string

N

The optional relay state that the API (service provider) sent to the identity provider.

SAMLResponse

string

Y

A message issued by the identity provider to the service provider

Responses

edit
302

(EmptyResponse) Redirects to the UI endpoint with an authorization token in the fragment and the relay state, if it was specified during the initialization.

401

(BasicFailedReply) The supplied SAML response is invalid. (code: root.unauthenticated)

501

(BasicFailedReply) You need to configure the authentication cluster. (code: authc.no_authentication_cluster)

502

(BasicFailedReply) The authentication cluster failed to process the request. The response body contains details about the error. (code: authc.authentication_cluster_error)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPOST {{hostname}}/api/v1/users/auth/saml/_callback \
-u $CLOUD_USER:$CLOUD_KEY
« Available authentication methods Initiate SAML protocol »