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.
{
"meta": {
"success": true,
"message": "Login success",
"devMessage": "Login success"
},
"body": {
"accessToken": "<JWT>",
"refreshToken": "<JWT>"
}
}
Errors#
Fix the request02
400Fix the request
Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values.
401Fix the request
Invalid credentials, disabled account, or authentication token problem.
Retry with backoff01
500Retry with backoff
Unexpected Returning.AI service error.
Retries
Repeating login will not mount the route. Do not send real passwords at this host to test it.
{
"status": "fail",
"message": "Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values."
}