Skip to content
From 0.5.0 the packages continue as @cqrs-ddd, documented at aristoteliss.github.io/ddd-cqrs; NestJS applications add @cqrs-ddd/nestjs. This site documents the 0.4.x line.

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" }'
x-tenant-schema
required
string

The tenant of the request.

Media typeapplication/json
object
email
required
string
code
required
string
>= 4 characters <= 6 characters
Examplegenerated
{
"email": "example",
"code": "example"
}

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"
}