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.

« SAML callback Delete API keys for a user »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.3] ›RESTful API ›API reference ›Authentication

Initiate SAML protocol

edit

Initiate SAML protocol

edit

Calls the authentication cluster to initiate SAML Single Sign-on (Web Browser SSO profile) protocol and redirects the user to the identity provider for authentication. The authentication cluster must be configured prior to initiation.

Request

edit

GET /api/v1/users/auth/saml/_init

Query parameters

edit
Name Type Required Description

state

string

N

An optional relay state that is sent back to the client after the user is authenticated

Responses

edit
302

(EmptyResponse) Redirects the client to the identity provider with a SAML authentication request

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 -XGET {{hostname}}/api/v1/users/auth/saml/_init \
-u $CLOUD_USER:$CLOUD_KEY
« SAML callback Delete API keys for a user »