Authenticate using credentials

POST 
/login

Authenticate using credentials

Request

Header Parameters

X-Domain stringrequired

Every request should has X-Domain Header, in the UUIDv4 format. The X-Domain can be get from the Tenant Integrations page

X-API-KEY stringrequired

An X-API-KEY key is a token that a client provides with a X-API-SECRET when making API calls, used instead of the JWT

X-API-SECRET stringrequired

An X-API-SECRET key is a token that a client provides with a X-API-KEY when making API calls, used instead of the JWT

application/vnd.api+json

Body

data

object

attributes

object

email string

An email of the registered user

password string

An password of the registered user

Responses

200

Successfully authorized

application/vnd.api+json

Schema

Schema

data

object

The authorisation code that should be changed to the JWT token

type string

id string

The id of the auth code internal

Example (from schema)

{
  "data": {
    "type": "auth_codes_internal",
    "id": "7e48b1a4-ccfc-4c6b-b03f-d9bb9ac4f883"
  }
}

422

The credentials is not equal to the saved values for user

application/vnd.api+json

Schema

Schema

status integer

The response status code of the error

code integer
title string

The title of the error

Example (from schema)

{
  "status": 422,
  "code": 0,
  "title": "Wrong Credential"
}

500

That means something has gone wrong on the server, and the server returns more specific about what the exact problem is

application/vnd.api+json

Schema

Schema

id object
type string

The type of the error

links string[]
status integer

The status of the error

code integer
title string

The title of the error

detail string
source object

The request body

meta object

The internal trace

Example (from schema)

{
  "id": {},
  "type": "errors",
  "links": [
    "string"
  ],
  "status": 0,
  "code": 0,
  "title": "string",
  "detail": "string",
  "source": {},
  "meta": {}
}

Loading...