-
Notifications
You must be signed in to change notification settings - Fork 0
User Auth API
Authentication endpoints for API usage.
All calls are made on the standard api endpoint:
https://api-prod.maxloapi.com
Retrieve a code to trade for a user_session_key for future communication with the API. Will generate an email to the specified address to authenticate the user. The email will contain a verification code that should be entered to receive a user_session_key for access to the API.
POST /api/1/user/email_code
None
email - string - Email address of user to authenticate
200 OK
Trade a email and code for a user_session_key.
POST /api/1/user/email_login
None
email - string - Email address of user to authenticate
login_code - string - Login code received by the user over email
200 OK
user_session_key - string - Authentication key for the session
user - object - User object containing user_id, email, user_name
Disable the current session.
POST /api/1/user/logout
user_session_key - string - provided in query string or body
None
200 OK
Successfully disabled the session_key.
Get information about the logged in user.
GET /api/1/user/current
user_session_key - string - provided in query string or body
None
200 OK
user_id - number - User ID
email - string - User email address
user_name - string - User display name
org_list - list of objects - List of organizations this user belongs to
-
org_id - number - Organization ID
-
org_name - string - Organization name
403 Forbidden
Not logged in