POST /api/v3/login

Authenticates a user with username, password, and data source, returning a JWT bearer token

LoginV3
Use this endpoint to obtain a bearer token for authenticating subsequent API calls. The returned token should be included in the Authorization header as “Bearer {token}”. No prior authentication is required.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Request Body

LoginRequest
Property Description Type
dataSource Datasource Required string
partition OPTIONAL - Partition Usually this is the environment, Staging, Pro, Web. An empty or NULL partition will result in all partitions being scanned. string
password Password Required string
username Username Required string
Example Request Body application/json 
{  "dataSource": "string",  "partition": "string",  "password": "string",  "username": "string"
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

LoginResponse
Property Description Type
token string
user ApiUser
ApiUser properties
Property Description Type
fullName string
userName string
Example Response application/json 
{  "token": "string",  "user": {    "fullName": "string",    "userName": "string"
  }
}