AuthsController_login

POST

/auths/login

curl --request POST \
  --url https://example.com/auths/login \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-schema: example' \
  --data '{ "email": "example", "code": "example" }'

Parameters

Header Parameters

x-tenant-schema

required

string

The tenant of the request.

Request Body^required

Media typeapplication/json

object

email

required

string

code

required

string

>= 4 characters <= 6 characters

Example^generated

{
  "email": "example",
  "code": "example"
}

Responses

200

The session and a short-lived access token. The refresh token is set as an HttpOnly cookie.

Media typeapplication/json

object

id

required

string

principalType

required

string

Allowed values: user service

tenant

required

string

email

required

string

department

required

string

nullable

accessToken

required

string

accessTokenExpiresAt

required

number

Example

{
  "principalType": "user"
}