Skip to content

Sign in

POST
/api/auth/signin
 
curl --request POST \
  --url http://localhost:3000/api/auth/signin \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]", "password": "example" }'

Rate-limited to 10 attempts per 15 minutes per IP.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
email
required
string format: email
password
required
string
Example generated
{
  "email": "[email protected]",
  "password": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Signed in. Sets a session cookie and returns the profile with sessionToken for non-browser clients (use as Cookie: session=).

Media type application/json
object
data
object
id
required
string format: uuid
email
required
string format: email
firstName
string
nullable
lastName
string
nullable
avatarUrl
string
nullable
role
required
string
Allowed values: super_admin administrator network_engineer sysadmin it_manager helpdesk procurement auditor read_only
isActive
required
boolean
createdAt
required
string format: date-time
sessionToken
string
Example 
{
  "data": {
    "role": "super_admin"
  }
}

401

Section titled “401 ”

Invalid email or password

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

403

Section titled “403 ”

Account deactivated

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

429

Section titled “429 ”

Too many signin attempts

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}