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.
Initiate SAML protocoledit
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.
Requestedit
GET /api/v1/users/auth/saml/_init
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
An optional relay state that is sent back to the client after the user is authenticated |
Responsesedit
-
302 -
(
EmptyResponse) Redirects the client to the identity provider with a SAML authentication request -
501 -
(
BasicFailedReply) The administrator needs to configure the authentication cluster. (code:authc.no_authentication_cluster)Headers
-
x-cloud-error-codes(string; allowed values: [authc.no_authentication_cluster]) - The error codes associated with the response
-
-
502 -
(
BasicFailedReply) The authentication cluster failed to process the request. The response body contains details about the error. (code:authc.authentication_cluster_error)Headers
-
x-cloud-error-codes(string; allowed values: [authc.authentication_cluster_error]) - The error codes associated with the response
-
Request exampleedit
curl -XGET https://{{hostname}}/api/v1/users/auth/saml/_init \
-H "Authorization: ApiKey $ECE_API_KEY"