Login to ECE

POST /users/auth/_login

Authenticates against available users.

Body Required

The login request

username string Required

The username part of the login request
password string Required

The plain text password part of the login request
login_state object

Configure how the API responds after a successful login.

Additional properties are allowed.
Hide login_state attribute Show login_state attribute object
- path string
  
  The path to which to redirect post login - if not specified then no redirect is performed, instead 200 is returned with the token in the body

Responses

200

Login successful, returns the token in the body (if 'login_state.path' not specified)
Hide response attributes Show response attributes object
- token string Required
  
  The authorization bearer token that you use in subsequent requests
- session_expiration_time string(date-time) Required
  
  The time that the session token will expire
302

Redirects to '/sso/token#BEARER_TOKEN?state=LOGIN_STATE' with the fragment containing a bearer token (if 'login_state.path' is specified)

Additional properties are allowed.
401

The supplied authentication is invalid. (code: root.unauthenticated)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is root.unauthenticated.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
501

The administrator needs to configure the authentication cluster. (code: authc.no_authentication_cluster)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is authc.no_authentication_cluster.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
502

The authentication cluster failed to process the request. The response body contains details about the error. (code: authc.authentication_cluster_error)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is authc.authentication_cluster_error.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

POST /users/auth/_login

curl \
 -X POST https://{{hostname}}/api/v1/users/auth/_login \
 -d '{"username":"string","password":"string","login_state":{"path":"string"}}'

Request examples

{
  "username": "string",
  "password": "string",
  "login_state": {
    "path": "string"
  }
}

Response examples (200)

{
  "token": "string",
  "session_expiration_time": "2024-05-04T09:42:00+00:00"
}

Response examples (302)

{}

Response examples (401)

# Headers
x-cloud-error-codes: root.unauthenticated

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (501)

# Headers
x-cloud-error-codes: authc.no_authentication_cluster

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (502)

# Headers
x-cloud-error-codes: authc.authentication_cluster_error

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}