Log in user with password
This page documents POST /auth/login.
- Method
- POST
- Path
https://api.returning.ai / auth/ login - Retries
- Repeating login will not mount the route.
Authentication#
- Header
Authorization: Bearer <API_KEY>
Password login is not the community API-key flow. A valid community key does not make this route exist.
Behaviour#
That login route is not mounted on https://api.returning.ai.
Do not use it for broker user ingestion. Create members with Create New User and look them up with Get User Data.
Request#
Headers#
Body#
Watch for
- Legacy Authentication pages describe an application login that this public API gateway does not serve.
GET /api/secureAuthalso 404s.- Register is the same class of unmounted route.
More examples and details
There is no success example.
POST /v1/auth/login→ HTML404Cannot POST /api/secureAuth/loginPOST /auth/login→404
curl --request POST \
--url https://api.returning.ai/auth/login \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"email": "savade@koletter.com",
"password": "@Password123",
"host": "ic.genesiv.com"
}'
Response#
This POST has no success response on https://api.returning.ai.
Eg{ ... }
Egtrue
Eg"Login success"
Eg"Login success"
Eg{ ... }
Eg"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE0NTA3NSIsImlhdCI6MTc0NjAwMTY1MywiZXhwIjoxNzQ2MDg4MDUzfQ.a-ee52XuvMtnV4tGgapFDNOh8kvGxswvzMJujSUFLxU"
Eg"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE0NTA3NSIsImlhdCI6MTc0NjAwMTY1MywiZXhwIjoxNzQ2NjA2NDUzfQ.Vuy6Va2QdkwPpsLpx1rurIkv9EcxM1zJapXz0Vj9f_U"
{
"meta": {
"success": true,
"message": "Login success",
"devMessage": "Login success"
},
"body": {
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE0NTA3NSIsImlhdCI6MTc0NjAwMTY1MywiZXhwIjoxNzQ2MDg4MDUzfQ.a-ee52XuvMtnV4tGgapFDNOh8kvGxswvzMJujSUFLxU",
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE0NTA3NSIsImlhdCI6MTc0NjAwMTY1MywiZXhwIjoxNzQ2NjA2NDUzfQ.Vuy6Va2QdkwPpsLpx1rurIkv9EcxM1zJapXz0Vj9f_U"
}
}
Errors#
Fix the request02
Retry with backoff01
{
"status": "fail",
"message": "Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values."
}