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.
Login to ECE
editLogin to ECE
editAuthenticates against available users.
Request
editPOST /api/v1/users/auth/_login
Request body
edit(LoginRequest
) (required) The login request
Responses
edit-
200
-
(
TokenResponse
) Login successful, returns the token in the body (if 'login_state.path' not specified) -
302
-
(
EmptyResponse
) Redirects to '/sso/token#BEARER_TOKEN?state=LOGIN_STATE' with the fragment containing a bearer token (if 'login_state.path' is specified) -
401
-
(
BasicFailedReply
) The supplied authentication 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
-
Request example
editcurl -XPOST https://{{hostname}}/api/v1/users/auth/_login \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "login_state" : { "path" : "string" }, "password" : "string", "username" : "string" } '