POST
/
v1
/
trace-learn
/
auth
/
student-login
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.traceLearn.traceLearnStudentLogin({
  body: {},
})
{
  "actor": {
    "actorId": "<string>",
    "displayName": "<string>",
    "organizationId": "<string>",
    "teamId": "<string>",
    "studentId": "<string>",
    "learnerKey": "<string>",
    "adminGrants": []
  },
  "session": {
    "kind": "student_pin",
    "sessionId": "<string>",
    "token": "<string>",
    "expiresAt": "<string>"
  },
  "firstDestination": "<string>"
}

Body

application/json
username
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
pin
string
required

a string at most 4 character(s) long

Required string length: 4

Response

Success

actor
object
required
session
object
required
firstDestination
string
required