Skip to content
Public API reference
/
/Authentication

Log in to the user account

Request

This endpoint is utilized for user authentication, granting access to secured endpoints that mandate authentication. Following successful authentication, a blaize_session is generated for the user, enabling them to access the secure endpoints.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Headers
cookiestring

The session cookie is employed to ascertain whether a user is already authenticated or has an active session.

Example:blaize_session=... (optional)
Bodyapplication/json
identifiersobjectrequired
Example:
{
  "email_address": "abc@company.com"
}
validatorsobjectrequired
Example:
{
  "password": "securepassword@123"
}
{
  "identifiers": {
    "email_address": "abc@company.com"
  },
  "validators": {
    "password": "securepassword@123"
  }
}

Responses

OK. The user has logged in successfully.

Headers
Bodyapplication/json
cookiestring

The authenticated user session.

Example:"blaize_session=443ed68f-0b44-4f32-8443-553d584cb0dd; Expires=Fri, 16 Nov 2018 12:35:56 GMT; Path=/;"
messagestring
Example:"Login successful"
tracking_idstring

The user tracking ID.

Example:"4fac49a6-e423-4ac1-b0ad-d678979344422"
Response
{
  "cookie": "blaize_session=443ed68f-0b44-4f32-8443-553d584cb0dd; Expires=Fri, 16 Nov 2018 12:35:56 GMT; Path=/;",
  "message": "Login successful",
  "tracking_id": "4fac49a6-e423-4ac1-b0ad-d678979344422"
}