Architecture

Session Management

Managing user sessions.


Requesting a session

You can request a session at any time.

GET /app/session

Returns a session object with values associated with the new account.

{
  "success": true,
  "message": "",
  "payload": {
    "auth": true,
    ...
    "app": {
      ...
    },
    "account": {
      ...
    },
    "user": {
      ...
    },
    "acccess": {
      ...
    },
    ...
  }
}

Session objects are also included as payloads in other endpoints, such as /app/login and /app/logout.


Authentication

The session object includes an auth node with the following properties:

  • true - The user is authenticated and the session is active.
  • false - The user is not authenticated.
  • select_account - The user belongs to multiple app accounts and must choose which one to activate for the session.

A session is considered authenticated when the app, account and user nodes are all present and valid.

Previous
API responses