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
editSAML callback
editAccepts a callback request from an identity provider and authenticates the user.
Request
editPOST /api/v1/users/auth/saml/_callback
Form Parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
The optional relay state that the API (service provider) sent to the identity provider. |
|
|
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)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthenticated]) - The error codes associated with the response
-
-
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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XPOST https://{{hostname}}/api/v1/users/auth/saml/_callback \
-H "Authorization: ApiKey $ECE_API_KEY"