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.

Elastic Docs ›Elastic Cloud Enterprise Reference [2.1] ›RESTful API ›API reference ›Authentication
« Enable elevated permissions Refresh authentication token »

Login to ECEedit

Authenticates against available users.

Requestedit

POST /api/v1/users/auth/_login

Request bodyedit

(LoginRequest) (required) The login request

Responsesedit

200

(TokenResponse) The login is successful. NOTE: When login_state.path is unspecified, the token is in the request body.

302

Redirecting to /sso/token#BEARER_TOKEN?state=LOGIN_STATE. NOTE: When login_state.path is specified, the bearer token is in the fragment.

400

(BasicFailedReply) The authentication cluster returned an error.

501

(BasicFailedReply) You need to configure the authentication cluster.

503

(BasicFailedReply) The authentication cluster failed to process the request. For details about the error, refer to the response body.

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

Request exampleedit

curl -XPOST {{hostname}}/api/v1/users/auth/_login \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "login_state" : {
      "path" : "string"
   },
   "password" : "string",
   "username" : "string"
}
'
« Enable elevated permissions Refresh authentication token »