POST ims/oneroster/v1p1/Login

Authenticate User Q Login. User Ident and encrypted Password passed in the request body.

Request Information

URI Parameters

None.

Body Parameters

JSON object returning the User's FacultyIdent, FacultyUnique, and Authenticated Flag.

LoginCredentials
NameDescriptionTypeAdditional information
FacultyKey

string

None.
FacultyValue

string

None.
PasswordSHA256

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "FacultyKey": "sample string 1",
  "FacultyValue": "sample string 2",
  "PasswordSHA256": "sample string 3"
}

application/xml, text/xml

Sample: 
<LoginCredentials xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FacultyKey>sample string 1</FacultyKey>
  <FacultyValue>sample string 2</FacultyValue>
  <PasswordSHA256>sample string 3</PasswordSHA256>
</LoginCredentials>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Authenticate User Q Login. User Ident and encrypted Password passed in the request body.

Object

None.

Response Formats

application/json, text/json

Sample: 
{}

application/xml, text/xml

Sample: 
<anyType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />