Skip to content

Provide an access_token for the user

Request

Provides an access_token for the email or the userId provided in the LoginCommand.
The accepted couples are:
[email, password]
[email, private_key]
[userId, private_key]

Bodyapplication/jsonrequired

A LoginCommand object

userIdinteger, (int64)

UserId (email or userId is required)

emailstring

User email (email or userId is required)

passwordstring

User Password (password or private_key is required)

private_keystring

Private key (password or private_key is required)

Example:"access_token"
curl -i -X POST \
  https://uberall.com/api/users/login \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": 0,
    "email": "string",
    "password": "string",
    "private_key": "access_token"
  }'

Responses

User successfully authenticated

Body*/*
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

User access_token

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "access_token": "string"
  }
}