POST v3/members/login

authenticate a user with email and the hash of password; SHA256 is used for the hash of password for now, we allow sso user who have set a password in the site login through the api.

Request Information

Parameters

Name	Description	Additional information
inVO	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "schoolId": "sample string 1",
  "redirectUrlString": "sample string 2",
  "nParameter": "sample string 3",
  "forApp": true,
  "forMadness": 5,
  "forAdminSite": true,
  "reCaptchaResponse": "sample string 7",
  "requireTurnstile": true,
  "email": "sample string 9",
  "password": "sample string 10",
  "curUserId": "sample string 11",
  "isSSO": true,
  "requestHost": "sample string 13",
  "applicationPath": "sample string 14",
  "secureApplicationPath": "sample string 15",
  "absoluteApplicationPath": "sample string 16",
  "isHttps": true,
  "isMobileDevice": true,
  "isElectron": true,
  "isFullEmbed": true,
  "clientType": 0,
  "clientVersion": "sample string 21",
  "clientOS": "sample string 22",
  "clientBuild": "sample string 23",
  "premiumAppId": "sample string 24",
  "clientWidth": 25,
  "clientHeight": 26,
  "timezone": 27
}

application/xml, text/xml

Sample:

<LoginInSchoolVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">
  <ClientHeight>26</ClientHeight>
  <ClientType>Site</ClientType>
  <ClientWidth>25</ClientWidth>
  <absoluteApplicationPath>sample string 16</absoluteApplicationPath>
  <applicationPath>sample string 14</applicationPath>
  <cachedKey>sample string 1</cachedKey>
  <clientBuild>sample string 23</clientBuild>
  <clientOS>sample string 22</clientOS>
  <clientVersion>sample string 21</clientVersion>
  <curUserId>sample string 11</curUserId>
  <isElectron>true</isElectron>
  <isFullEmbed>true</isFullEmbed>
  <isHttps>true</isHttps>
  <isMobileDevice>true</isMobileDevice>
  <isSSO>true</isSSO>
  <premiumAppId>sample string 24</premiumAppId>
  <requestHost>sample string 13</requestHost>
  <secureApplicationPath>sample string 15</secureApplicationPath>
  <timezone>27</timezone>
  <Email>sample string 9</Email>
  <Password>sample string 10</Password>
  <ForAdminSite>true</ForAdminSite>
  <ForApp>true</ForApp>
  <ForMadness>5</ForMadness>
  <NParameter>sample string 3</NParameter>
  <ReCaptchaResponse>sample string 7</ReCaptchaResponse>
  <RedirectUrlString>sample string 2</RedirectUrlString>
  <RequireTurnstile>true</RequireTurnstile>
  <SchoolId>sample string 1</SchoolId>
</LoginInSchoolVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="cachedKey"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

the authenticated member object for the user

Response body formats

application/json, text/json, multipart/form-data

Sample:

Sample not available.