Skip to content
Patrimoine
v9.1.0

Local Login

POST
/auth/login
curl --request POST \
  --url https://example.com/auth/login \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "password": "example", "totp_code": "example", "device_name": "example" }'

Authenticate with email and password (local auth).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
LoginRequest
object
email
required
Email
string format: email
password
required
Password
string
<= 1024 characters
totp_code
Any of:
string
<= 32 characters
device_name
Any of:
string
<= 100 characters

Example generated

{
  "email": "hello@example.com",
  "password": "example",
  "totp_code": "example",
  "device_name": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json

Example generated

example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}