SMsmarkets
sessions

Login using this route.

Changed on

Description

This will return a token that can be used in the Authentication header in the form "Session-Token <your_token>" on authenticated requests.<br> The token is valid for 30min, but if you make an authenticated request with it, it will be renewed for the next 30min.

Rate limits

Maximum 5 requests per 300 seconds<br>

post/v3/sessions/

Request

Request body

create_social_memberboolean

If true, and the user logging in does not have an associated social member,this call will also take care of creating the social member for this user

passwordstring required

Your account password

rememberboolean

True if the client wants Smarkets to allow this device to renew the token even after its expiration

reopen_accountboolean

If true, and the user has closed their own account,then their account will be reopened and they will log in as normal.

use_auth_v2boolean

If true, and the user logging will be forced to use auth v2,and should expect refresh_token and access_token in the cookies and response

usernamestring email required

Your username

Example request

{
  "create_social_member": true,
  "password": "verysecurepassword",
  "remember": true,
  "username": "john.doe@company.com"
}

Response

Token response for old and new auth v2.

OR

Example response

{
  "created_social_member": true,
  "factor": "complete",
  "nemid_session_id": "776071e7-6b96-41af-8fa2-7fed98e227fd",
  "redirect_url": "https://test.zignsec.com/v2/Hosted/776071e7-6b96-41af-8fa2-7fed98e227fd/nemid/",
  "stop": "2018-01-24T19:49:43.964757",
  "token": "WzM2NjI1MDIsMjIyMDIxMzJd.jKWaw5j3XtYX6huY7HZVEvISu6k",
  "verify": true
}

Changes

  • 75f7e3050340Revision changes
    • warning

      added the new LOGIN_VERIFICATION_REQUIRED enum value to the response property for the response status

  • 9912a2182e61Revision changes
    • warning

      added the new USER_SELF_SUSPENDED enum value to the response property for the response status

    • info

      added the new optional request property