[{"data":1,"prerenderedAt":1724},["ShallowReactive",2],{"api-nav":3,"api-spec:index":351,"api-spec:op:create-signin-link":636,"api-permissions-guide":1003,"api-reference-doc:create-signin-link":1004},[4,28,57,95,115,301,317,331],{"id":5,"title":6,"links":7,"groups":27},"start","Start here",[8,11,15,18,21,24],{"title":9,"to":10},"Overview","\u002Fapi",{"title":12,"to":13,"status":14},"Quickstart","\u002Fapi\u002Fquickstart","available",{"title":16,"to":17,"status":14},"Environments","\u002Fapi\u002Fenvironments",{"title":19,"to":20,"status":14},"Authentication","\u002Fapi\u002Fauthentication",{"title":22,"to":23,"status":14},"Organizations","\u002Fapi\u002Forganizations",{"title":25,"to":26,"status":14},"Permissions","\u002Fapi\u002Fpermissions",[],{"id":29,"title":30,"links":31,"groups":56},"concepts","Concepts",[32,35,38,41,44,47,50,53],{"title":33,"to":34,"status":14},"Requests and responses","\u002Fapi\u002Frequests-and-responses",{"title":36,"to":37,"status":14},"Identifiers","\u002Fapi\u002Fidentifiers",{"title":39,"to":40,"status":14},"Pagination","\u002Fapi\u002Fpagination",{"title":42,"to":43},"Errors","\u002Fapi\u002Ferrors",{"title":45,"to":46,"status":14},"Rate limits","\u002Fapi\u002Frate-limits",{"title":48,"to":49,"status":14},"Retries","\u002Fapi\u002Fretries-and-idempotency",{"title":51,"to":52,"status":14},"Security","\u002Fapi\u002Fsecurity",{"title":54,"to":55,"status":14},"Versioning","\u002Fapi\u002Fversioning",[],{"id":58,"title":59,"links":60,"groups":94},"resources","Guides",[61,64,67,70,73,76,79,82,85,88,91],{"title":62,"to":63,"status":14},"Students","\u002Fapi\u002Fguides\u002Fstudents",{"title":65,"to":66,"status":14},"Bulk registration","\u002Fapi\u002Fguides\u002Fbulk-registration",{"title":68,"to":69,"status":14},"Passwords","\u002Fapi\u002Fguides\u002Fpasswords",{"title":71,"to":72,"status":14},"Supervisors","\u002Fapi\u002Fguides\u002Fsupervisors",{"title":74,"to":75,"status":14},"Reference data","\u002Fapi\u002Fguides\u002Freference-data",{"title":77,"to":78,"status":14},"API account","\u002Fapi\u002Fguides\u002Fapi-account",{"title":80,"to":81,"status":14},"Sign-in links","\u002Fapi\u002Fguides\u002Fsign-in-links",{"title":83,"to":84,"status":14},"Exams","\u002Fapi\u002Fguides\u002Fexams",{"title":86,"to":87,"status":14},"Applications","\u002Fapi\u002Fguides\u002Fapplications",{"title":89,"to":90,"status":14},"Group challenges","\u002Fapi\u002Fguides\u002Fgroup-challenges",{"title":92,"to":93,"status":14},"Certificates and reports","\u002Fapi\u002Fguides\u002Fcertificates-and-reports",[],{"id":96,"title":97,"links":98,"groups":114},"tutorials","Tutorials",[99,102,105,108,111],{"title":100,"to":101,"status":14},"Register and apply","\u002Fapi\u002Ftutorials\u002Fregister-and-apply",{"title":103,"to":104,"status":14},"Send a student to the panel","\u002Fapi\u002Ftutorials\u002Fsend-student-to-panel",{"title":106,"to":107,"status":14},"Change an application","\u002Fapi\u002Ftutorials\u002Fchange-an-application",{"title":109,"to":110,"status":14},"Collect results","\u002Fapi\u002Ftutorials\u002Fcollect-results",{"title":112,"to":113,"status":14},"Token handling","\u002Fapi\u002Ftutorials\u002Ftoken-handling",[],{"id":116,"title":117,"links":118,"groups":125},"reference","Reference",[119,122],{"title":120,"to":121},"All endpoints","\u002Fapi\u002Freference",{"title":123,"to":124},"Sandbox console","\u002Fapi\u002Fconsole",[126,135,145,166,206,212,230,255,271],{"tag":127,"slug":128,"links":129},"Health","health",[130],{"title":131,"to":132,"method":133,"deprecated":134},"Check that the API is up","\u002Fapi\u002Freference\u002Fget-health","GET",false,{"tag":77,"slug":136,"links":137},"api-account",[138,142],{"title":139,"to":140,"method":141,"deprecated":134},"Revoke the token you send, before it expires","\u002Fapi\u002Freference\u002Frevoke-token","POST",{"title":143,"to":144,"method":133,"deprecated":134},"Fetch the API account your token belongs to","\u002Fapi\u002Freference\u002Fget-current-api-account",{"tag":74,"slug":146,"links":147},"reference-data",[148,151,154,157,160,163],{"title":149,"to":150,"method":133,"deprecated":134},"List the countries a student can be registered in","\u002Fapi\u002Freference\u002Flist-countries",{"title":152,"to":153,"method":133,"deprecated":134},"Fetch one country by its id","\u002Fapi\u002Freference\u002Fget-country",{"title":155,"to":156,"method":133,"deprecated":134},"List the grades a student can be registered with","\u002Fapi\u002Freference\u002Flist-grades",{"title":158,"to":159,"method":133,"deprecated":134},"Fetch one grade by its id","\u002Fapi\u002Freference\u002Fget-grade",{"title":161,"to":162,"method":133,"deprecated":134},"List the organizations and their ids","\u002Fapi\u002Freference\u002Flist-organizations",{"title":164,"to":165,"method":133,"deprecated":134},"Fetch one organization by its id","\u002Fapi\u002Freference\u002Fget-organization",{"tag":62,"slug":167,"links":168},"students",[169,172,175,178,181,184,187,191,194,197,200,203],{"title":170,"to":171,"method":133,"deprecated":134},"List your students","\u002Fapi\u002Freference\u002Flist-students",{"title":173,"to":174,"method":141,"deprecated":134},"Register a student","\u002Fapi\u002Freference\u002Fregister-student",{"title":176,"to":177,"method":141,"deprecated":134},"Check a registration without registering the student","\u002Fapi\u002Freference\u002Fcheck-student-registration",{"title":179,"to":180,"method":141,"deprecated":134},"Register many students at once","\u002Fapi\u002Freference\u002Fcreate-student-import",{"title":182,"to":183,"method":133,"deprecated":134},"Follow a batch of students you sent","\u002Fapi\u002Freference\u002Fget-student-import",{"title":185,"to":186,"method":133,"deprecated":134},"Fetch one of your students","\u002Fapi\u002Freference\u002Fget-student",{"title":188,"to":189,"method":190,"deprecated":134},"Update one of your students","\u002Fapi\u002Freference\u002Fupdate-student","PUT",{"title":192,"to":193,"method":190,"deprecated":134},"Set the sign-in password of one of your students","\u002Fapi\u002Freference\u002Fset-student-password",{"title":195,"to":196,"method":133,"deprecated":134},"List your students who can use this organization","\u002Fapi\u002Freference\u002Flist-org-students",{"title":198,"to":199,"method":133,"deprecated":134},"Fetch one of your students, if they can use this organization","\u002Fapi\u002Freference\u002Fget-org-student",{"title":201,"to":202,"method":190,"deprecated":134},"Update one of your students and give them access to this organization","\u002Fapi\u002Freference\u002Fupdate-org-student",{"title":204,"to":205,"method":190,"deprecated":134},"Link one of your students to a supervisor on this organization","\u002Fapi\u002Freference\u002Flink-student-supervisor",{"tag":80,"slug":207,"links":208},"sign-in-links",[209],{"title":210,"to":211,"method":141,"deprecated":134},"Create a single-use sign-in link for one of your students","\u002Fapi\u002Freference\u002Fcreate-signin-link",{"tag":83,"slug":213,"links":214},"exams",[215,218,221,224,227],{"title":216,"to":217,"method":133,"deprecated":134},"List the exams open for applications","\u002Fapi\u002Freference\u002Flist-exams",{"title":219,"to":220,"method":133,"deprecated":134},"List an organization’s exam categories","\u002Fapi\u002Freference\u002Flist-exam-categories",{"title":222,"to":223,"method":133,"deprecated":134},"Fetch one exam category","\u002Fapi\u002Freference\u002Fget-exam-category",{"title":225,"to":226,"method":133,"deprecated":134},"List the exams one of your students can apply to","\u002Fapi\u002Freference\u002Flist-available-exams",{"title":228,"to":229,"method":133,"deprecated":134},"Fetch one exam that is open for applications","\u002Fapi\u002Freference\u002Fget-exam",{"tag":86,"slug":231,"links":232},"applications",[233,236,239,242,245,248,251],{"title":234,"to":235,"method":133,"deprecated":134},"List your students’ applications in this organization","\u002Fapi\u002Freference\u002Flist-applications",{"title":237,"to":238,"method":141,"deprecated":134},"Enter one of your students for an exam","\u002Fapi\u002Freference\u002Fcreate-application",{"title":240,"to":241,"method":133,"deprecated":134},"List your students’ applications for one exam","\u002Fapi\u002Freference\u002Flist-exam-applications",{"title":243,"to":244,"method":133,"deprecated":134},"List one of your students’ applications in this organization","\u002Fapi\u002Freference\u002Flist-student-applications",{"title":246,"to":247,"method":133,"deprecated":134},"Fetch one of your students’ applications","\u002Fapi\u002Freference\u002Fget-application",{"title":249,"to":250,"method":190,"deprecated":134},"Move one of your students’ applications to another exam","\u002Fapi\u002Freference\u002Fmove-application",{"title":252,"to":253,"method":254,"deprecated":134},"Withdraw one of your students from an exam","\u002Fapi\u002Freference\u002Fdelete-application","DELETE",{"tag":256,"slug":257,"links":258},"Documents","documents",[259,262,265,268],{"title":260,"to":261,"method":133,"deprecated":134},"Download a certificate file","\u002Fapi\u002Freference\u002Fdownload-certificate",{"title":263,"to":264,"method":133,"deprecated":134},"List one of your students’ released certificates","\u002Fapi\u002Freference\u002Flist-student-certificates",{"title":266,"to":267,"method":133,"deprecated":134},"Download a result report file","\u002Fapi\u002Freference\u002Fdownload-report",{"title":269,"to":270,"method":133,"deprecated":134},"List one of your students’ released result reports","\u002Fapi\u002Freference\u002Flist-student-reports",{"tag":89,"slug":272,"links":273},"group-challenges",[274,277,280,283,286,289,292,295,298],{"title":275,"to":276,"method":133,"deprecated":134},"List the group challenges an organization runs","\u002Fapi\u002Freference\u002Flist-group-challenges",{"title":278,"to":279,"method":133,"deprecated":134},"Fetch one group challenge","\u002Fapi\u002Freference\u002Fget-group-challenge",{"title":281,"to":282,"method":133,"deprecated":134},"List the groups your students are in for a group challenge","\u002Fapi\u002Freference\u002Flist-group-challenge-groups",{"title":284,"to":285,"method":133,"deprecated":134},"Fetch one group, with its steps and files","\u002Fapi\u002Freference\u002Fget-group-challenge-group",{"title":287,"to":288,"method":133,"deprecated":134},"List what has happened in one group","\u002Fapi\u002Freference\u002Flist-group-challenge-activity",{"title":290,"to":291,"method":141,"deprecated":134},"Send a group’s finished work for one of your students","\u002Fapi\u002Freference\u002Fsubmit-group-challenge-work",{"title":293,"to":294,"method":141,"deprecated":134},"Submit one step of a group for one of your students","\u002Fapi\u002Freference\u002Fsubmit-group-challenge-step",{"title":296,"to":297,"method":133,"deprecated":134},"List your students’ eligibility and groups for a group challenge","\u002Fapi\u002Freference\u002Flist-group-challenge-students",{"title":299,"to":300,"method":133,"deprecated":134},"Fetch one of your students’ eligibility and group for a group challenge","\u002Fapi\u002Freference\u002Fget-group-challenge-student",{"id":302,"title":303,"links":304,"groups":316},"clients","Clients",[305,307,310,313],{"title":9,"to":306,"status":14},"\u002Fapi\u002Fclients",{"title":308,"to":309,"status":14},"Node.js","\u002Fapi\u002Fclients\u002Fnode",{"title":311,"to":312,"status":14},"PHP","\u002Fapi\u002Fclients\u002Fphp",{"title":314,"to":315,"status":14},"Build your own","\u002Fapi\u002Fclients\u002Fbuild-your-own",[],{"id":318,"title":319,"links":320,"groups":330},"agents","AI agents",[321,324,327],{"title":322,"to":323},"AI connections","\u002Fapi\u002Fmcp",{"title":325,"to":326},"What it can do","\u002Fapi\u002Fmcp\u002Ftools",{"title":328,"to":329},"Agent skills","\u002Fapi\u002Fskills",[],{"id":332,"title":333,"links":334,"groups":350},"help","Help",[335,338,341,344,347],{"title":336,"to":337,"status":14},"Glossary","\u002Fapi\u002Fglossary",{"title":339,"to":340,"status":14},"FAQ","\u002Fapi\u002Ffaq",{"title":342,"to":343,"status":14},"Troubleshooting","\u002Fapi\u002Ftroubleshooting",{"title":345,"to":346,"status":14},"Support","\u002Fapi\u002Fsupport",{"title":348,"to":349},"Changelog","\u002Fapi\u002Fchangelog",[],{"title":352,"version":353,"description":354,"baseUrl":355,"groups":356},"Main Team API","1.2.0","Register your students, enter them for exams, follow their applications, download their certificates and reports, and sign them in to an organization’s panel.\n\nEvery operation except the health check needs a bearer token: a JWT you sign yourself with HS256 and your account’s `apiSecret`. Put your `apiKey` in both the `kid` header and the `sub` claim, and set `iat` and `exp` at most 3600 seconds apart. Every authentication failure answers the same `401 unauthorized`.","https:\u002F\u002Fapi.main-team.org",[357,368,383,419,484,492,522,561,586],{"tag":127,"slug":128,"description":358,"guide":17,"operations":359},"Whether the API is up. No token needed, so it is the first call to make against an environment.",[360],{"operationId":361,"slug":362,"method":133,"path":363,"tag":127,"summary":131,"deprecated":134,"public":364,"permission":365,"scope":366,"order":367},"getHealth","get-health","\u002Fv1\u002Fhealth",true,null,"public",1,{"tag":77,"slug":136,"description":369,"guide":78,"operations":370},"The account your token belongs to, and revoking a token before it expires.",[371,378],{"operationId":372,"slug":373,"method":141,"path":374,"tag":77,"summary":139,"deprecated":134,"public":134,"permission":375,"scope":376,"order":377},"revokeToken","revoke-token","\u002Fv1\u002Fapi-account\u002Frevoke-token","api\u002F*:$org:$ID","flat",2,{"operationId":379,"slug":380,"method":133,"path":381,"tag":77,"summary":143,"deprecated":134,"public":134,"permission":375,"scope":376,"order":382},"getCurrentApiAccount","get-current-api-account","\u002Fv1\u002Fapi-account\u002Fvalidate-me",3,{"tag":74,"slug":146,"description":384,"guide":75,"operations":385},"Countries, grades and organizations. A student’s `country` and `grade` take these `_id`s, and so does every `:organizationId` in a path.",[386,392,397,403,408,414],{"operationId":387,"slug":388,"method":133,"path":389,"tag":74,"summary":149,"deprecated":134,"public":134,"permission":390,"scope":376,"order":391},"listCountries","list-countries","\u002Fv1\u002Fcountry","country\u002Fread:$org:$ID",4,{"operationId":393,"slug":394,"method":133,"path":395,"tag":74,"summary":152,"deprecated":134,"public":134,"permission":390,"scope":376,"order":396},"getCountry","get-country","\u002Fv1\u002Fcountry\u002F{id}",5,{"operationId":398,"slug":399,"method":133,"path":400,"tag":74,"summary":155,"deprecated":134,"public":134,"permission":401,"scope":376,"order":402},"listGrades","list-grades","\u002Fv1\u002Fgrade","grade\u002Fread:$org:$ID",6,{"operationId":404,"slug":405,"method":133,"path":406,"tag":74,"summary":158,"deprecated":134,"public":134,"permission":401,"scope":376,"order":407},"getGrade","get-grade","\u002Fv1\u002Fgrade\u002F{id}",7,{"operationId":409,"slug":410,"method":133,"path":411,"tag":74,"summary":161,"deprecated":134,"public":134,"permission":412,"scope":376,"order":413},"listOrganizations","list-organizations","\u002Fv1\u002Forganization","organization\u002Fread:$org:$ID",8,{"operationId":415,"slug":416,"method":133,"path":417,"tag":74,"summary":164,"deprecated":134,"public":134,"permission":412,"scope":376,"order":418},"getOrganization","get-organization","\u002Fv1\u002Forganization\u002F{id}",9,{"tag":62,"slug":167,"description":420,"guide":63,"operations":421},"Registering your students, reading and updating them, setting a password, and what each organization holds for them. You only ever see the students your account registered.",[422,428,433,438,443,448,453,458,464,470,475,479],{"operationId":423,"slug":424,"method":133,"path":425,"tag":62,"summary":170,"deprecated":134,"public":134,"permission":426,"scope":376,"order":427},"listStudents","list-students","\u002Fv1\u002Fstudent","student\u002Fread:$org:$ID",10,{"operationId":429,"slug":430,"method":141,"path":425,"tag":62,"summary":173,"deprecated":134,"public":134,"permission":431,"scope":376,"order":432},"registerStudent","register-student","student\u002Fcreate:$org:$ID",11,{"operationId":434,"slug":435,"method":141,"path":436,"tag":62,"summary":176,"deprecated":134,"public":134,"permission":431,"scope":376,"order":437},"checkStudentRegistration","check-student-registration","\u002Fv1\u002Fstudent\u002Fcheck",12,{"operationId":439,"slug":440,"method":141,"path":441,"tag":62,"summary":179,"deprecated":134,"public":134,"permission":431,"scope":376,"order":442},"createStudentImport","create-student-import","\u002Fv1\u002Fstudent\u002Fimport",13,{"operationId":444,"slug":445,"method":133,"path":446,"tag":62,"summary":182,"deprecated":134,"public":134,"permission":431,"scope":376,"order":447},"getStudentImport","get-student-import","\u002Fv1\u002Fstudent\u002Fimport\u002F{importId}",14,{"operationId":449,"slug":450,"method":133,"path":451,"tag":62,"summary":185,"deprecated":134,"public":134,"permission":426,"scope":376,"order":452},"getStudent","get-student","\u002Fv1\u002Fstudent\u002F{studentId}",15,{"operationId":454,"slug":455,"method":190,"path":451,"tag":62,"summary":188,"deprecated":134,"public":134,"permission":456,"scope":376,"order":457},"updateStudent","update-student","student\u002Fupdate:$org:$ID",16,{"operationId":459,"slug":460,"method":190,"path":461,"tag":62,"summary":192,"deprecated":134,"public":134,"permission":462,"scope":376,"order":463},"setStudentPassword","set-student-password","\u002Fv1\u002Fstudent\u002F{studentId}\u002Fpassword","auth\u002Fsignin:$org:$ID",17,{"operationId":465,"slug":466,"method":133,"path":467,"tag":62,"summary":195,"deprecated":134,"public":134,"permission":426,"scope":468,"order":469},"listOrgStudents","list-org-students","\u002Fv1\u002F{organizationId}\u002Fstudent","organization",18,{"operationId":471,"slug":472,"method":133,"path":473,"tag":62,"summary":198,"deprecated":134,"public":134,"permission":426,"scope":468,"order":474},"getOrgStudent","get-org-student","\u002Fv1\u002F{organizationId}\u002Fstudent\u002F{studentId}",19,{"operationId":476,"slug":477,"method":190,"path":473,"tag":62,"summary":201,"deprecated":134,"public":134,"permission":456,"scope":468,"order":478},"updateOrgStudent","update-org-student",20,{"operationId":480,"slug":481,"method":190,"path":482,"tag":62,"summary":204,"deprecated":134,"public":134,"permission":456,"scope":468,"order":483},"linkStudentSupervisor","link-student-supervisor","\u002Fv1\u002F{organizationId}\u002Fstudent\u002F{studentId}\u002Fsupervisor",21,{"tag":80,"slug":207,"description":485,"guide":81,"operations":486},"Links that sign one of your students into an organization’s panel. Each works once and expires two minutes after it is issued.",[487],{"operationId":488,"slug":489,"method":141,"path":490,"tag":80,"summary":210,"deprecated":134,"public":134,"permission":462,"scope":468,"order":491},"createSigninLink","create-signin-link","\u002Fv1\u002F{organizationId}\u002Fauth\u002Fsignin",22,{"tag":83,"slug":213,"description":493,"guide":84,"operations":494},"The exam categories and exams an organization runs, and the ones one of your students can apply to.",[495,501,507,512,517],{"operationId":496,"slug":497,"method":133,"path":498,"tag":83,"summary":216,"deprecated":134,"public":134,"permission":499,"scope":468,"order":500},"listExams","list-exams","\u002Fv1\u002F{organizationId}\u002Fexam","exam\u002Fread:$org:$ID",23,{"operationId":502,"slug":503,"method":133,"path":504,"tag":83,"summary":219,"deprecated":134,"public":134,"permission":505,"scope":468,"order":506},"listExamCategories","list-exam-categories","\u002Fv1\u002F{organizationId}\u002Fexam-category","exam-category\u002Fread:$org:$ID",24,{"operationId":508,"slug":509,"method":133,"path":510,"tag":83,"summary":222,"deprecated":134,"public":134,"permission":505,"scope":468,"order":511},"getExamCategory","get-exam-category","\u002Fv1\u002F{organizationId}\u002Fexam-category\u002F{categoryId}",25,{"operationId":513,"slug":514,"method":133,"path":515,"tag":83,"summary":225,"deprecated":134,"public":134,"permission":499,"scope":468,"order":516},"listAvailableExams","list-available-exams","\u002Fv1\u002F{organizationId}\u002Fexam\u002Favailable\u002F{studentId}",26,{"operationId":518,"slug":519,"method":133,"path":520,"tag":83,"summary":228,"deprecated":134,"public":134,"permission":499,"scope":468,"order":521},"getExam","get-exam","\u002Fv1\u002F{organizationId}\u002Fexam\u002F{examId}",27,{"tag":86,"slug":231,"description":523,"guide":87,"operations":524},"Entering your students for exams: creating, reading, moving and deleting their applications.",[525,531,536,541,546,551,556],{"operationId":526,"slug":527,"method":133,"path":528,"tag":86,"summary":234,"deprecated":134,"public":134,"permission":529,"scope":468,"order":530},"listApplications","list-applications","\u002Fv1\u002F{organizationId}\u002Fapplication","application\u002Fread:$org:$ID",28,{"operationId":532,"slug":533,"method":141,"path":528,"tag":86,"summary":237,"deprecated":134,"public":134,"permission":534,"scope":468,"order":535},"createApplication","create-application","application\u002Fcreate:$org:$ID",29,{"operationId":537,"slug":538,"method":133,"path":539,"tag":86,"summary":240,"deprecated":134,"public":134,"permission":529,"scope":468,"order":540},"listExamApplications","list-exam-applications","\u002Fv1\u002F{organizationId}\u002Fapplication\u002Fexam-applications\u002F{examId}",30,{"operationId":542,"slug":543,"method":133,"path":544,"tag":86,"summary":243,"deprecated":134,"public":134,"permission":529,"scope":468,"order":545},"listStudentApplications","list-student-applications","\u002Fv1\u002F{organizationId}\u002Fapplication\u002Fstudent-applications\u002F{studentId}",31,{"operationId":547,"slug":548,"method":133,"path":549,"tag":86,"summary":246,"deprecated":134,"public":134,"permission":529,"scope":468,"order":550},"getApplication","get-application","\u002Fv1\u002F{organizationId}\u002Fapplication\u002F{applicationId}",32,{"operationId":552,"slug":553,"method":190,"path":549,"tag":86,"summary":249,"deprecated":134,"public":134,"permission":554,"scope":468,"order":555},"moveApplication","move-application","application\u002Fupdate:$org:$ID",33,{"operationId":557,"slug":558,"method":254,"path":549,"tag":86,"summary":252,"deprecated":134,"public":134,"permission":559,"scope":468,"order":560},"deleteApplication","delete-application","application\u002Fdelete:$org:$ID",34,{"tag":256,"slug":257,"description":562,"guide":93,"operations":563},"Your students’ certificates and reports: listing them and downloading the files.",[564,570,575,581],{"operationId":565,"slug":566,"method":133,"path":567,"tag":256,"summary":260,"deprecated":134,"public":134,"permission":568,"scope":468,"order":569},"downloadCertificate","download-certificate","\u002Fv1\u002F{organizationId}\u002Fcertificate\u002Fdownload\u002F{certificateId}","certificate\u002Fread:$org:$ID",35,{"operationId":571,"slug":572,"method":133,"path":573,"tag":256,"summary":263,"deprecated":134,"public":134,"permission":568,"scope":468,"order":574},"listStudentCertificates","list-student-certificates","\u002Fv1\u002F{organizationId}\u002Fcertificate\u002F{userId}",36,{"operationId":576,"slug":577,"method":133,"path":578,"tag":256,"summary":266,"deprecated":134,"public":134,"permission":579,"scope":468,"order":580},"downloadReport","download-report","\u002Fv1\u002F{organizationId}\u002Freport\u002Fdownload\u002F{reportId}","report\u002Fread:$org:$ID",37,{"operationId":582,"slug":583,"method":133,"path":584,"tag":256,"summary":269,"deprecated":134,"public":134,"permission":579,"scope":468,"order":585},"listStudentReports","list-student-reports","\u002Fv1\u002F{organizationId}\u002Freport\u002F{userId}",38,{"tag":89,"slug":272,"description":587,"guide":90,"operations":588},"Online group challenges your students take part in: the challenges, which of your students can join, the groups they are in, each step and its files, what happened in a group, and submitting on your student’s behalf.",[589,595,600,605,610,615,621,626,631],{"operationId":590,"slug":591,"method":133,"path":592,"tag":89,"summary":275,"deprecated":134,"public":134,"permission":593,"scope":468,"order":594},"listGroupChallenges","list-group-challenges","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge","group-challenge\u002Fread:$org:$ID",39,{"operationId":596,"slug":597,"method":133,"path":598,"tag":89,"summary":278,"deprecated":134,"public":134,"permission":593,"scope":468,"order":599},"getGroupChallenge","get-group-challenge","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}",40,{"operationId":601,"slug":602,"method":133,"path":603,"tag":89,"summary":281,"deprecated":134,"public":134,"permission":593,"scope":468,"order":604},"listGroupChallengeGroups","list-group-challenge-groups","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fgroup",41,{"operationId":606,"slug":607,"method":133,"path":608,"tag":89,"summary":284,"deprecated":134,"public":134,"permission":593,"scope":468,"order":609},"getGroupChallengeGroup","get-group-challenge-group","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fgroup\u002F{groupId}",42,{"operationId":611,"slug":612,"method":133,"path":613,"tag":89,"summary":287,"deprecated":134,"public":134,"permission":593,"scope":468,"order":614},"listGroupChallengeActivity","list-group-challenge-activity","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fgroup\u002F{groupId}\u002Factivity",43,{"operationId":616,"slug":617,"method":141,"path":618,"tag":89,"summary":290,"deprecated":134,"public":134,"permission":619,"scope":468,"order":620},"submitGroupChallengeWork","submit-group-challenge-work","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fgroup\u002F{groupId}\u002Ffinal-submit","group-challenge\u002Fsubmit:$org:$ID",44,{"operationId":622,"slug":623,"method":141,"path":624,"tag":89,"summary":293,"deprecated":134,"public":134,"permission":619,"scope":468,"order":625},"submitGroupChallengeStep","submit-group-challenge-step","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fgroup\u002F{groupId}\u002Fstep\u002F{stepId}\u002Fsubmit",45,{"operationId":627,"slug":628,"method":133,"path":629,"tag":89,"summary":296,"deprecated":134,"public":134,"permission":593,"scope":468,"order":630},"listGroupChallengeStudents","list-group-challenge-students","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fstudent",46,{"operationId":632,"slug":633,"method":133,"path":634,"tag":89,"summary":299,"deprecated":134,"public":134,"permission":593,"scope":468,"order":635},"getGroupChallengeStudent","get-group-challenge-student","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fstudent\u002F{studentId}",47,{"operationId":488,"slug":489,"method":141,"path":490,"tag":80,"summary":210,"deprecated":134,"public":134,"permission":462,"scope":468,"order":491,"description":637,"permissions":638,"errors":639,"guide":365,"parameters":688,"requestBody":697,"responses":713,"successStatus":1001,"kind":1002,"paginated":134,"baseUrl":355,"tagDescription":485,"sandbox":364},"Returns a URL that signs the student in to this organization’s student panel. **It works once, and for 120 seconds** (`expiresIn`) from when it is issued, whether or not anyone opened it. Whoever opens it first is signed in as the student, and a second visit is refused, so:\n\n- redirect the student’s browser to it straight away;\n- never log it, email it or show it anywhere else;\n- ask for a new link for every sign-in.\n\nEach call issues a new link and leaves the earlier ones as they were until they expire. Nothing is issued to your account: no token, cookie or session, only the URL.\n\n**The student needs access to this organization first:** their `activatedPlatformsThisSeason` must hold this organization’s `slug` or `common`. `registerStudent` gives `common` unless you send a list; otherwise grant access with `updateOrgStudent`. Without it the answer is 403 with a message saying so, and nothing is changed.\n\nThe student does not need a confirmed email address: a student you have just registered can be sent a link straight away.\n\n`redirect` chooses where on the panel the student lands. Leave it out to land on the organization’s `defaultRedirect`, as `getOrganization` shows it.\n\n**Make this the first call for a student new to this organization.** The organization creates its own record of a student the first time they open a link to it, and `linkStudentSupervisor` and the application, certificate and report operations on this organization need that record.\n\nOnly students your account registered can be signed in; another account’s student answers 404, like an unknown id.",[462],[640,644,647,651,656,659,664,667,672,677,681,685],{"code":641,"status":642,"when":643},"bad_request",400,"The body is not valid JSON, breaks a field’s rules, or has a field this operation does not accept (\"property \u003Cname> should not exist\").",{"code":641,"message":645,"status":642,"when":646},"redirect must be a site-relative path starting with \"\u002F\" (e.g. \"\u002Fdashboard\")","`redirect` is not a path on the panel: it needs one leading `\u002F`, and no whitespace or backslash anywhere.",{"code":648,"status":649,"when":650},"unauthorized",401,"The token is missing or malformed, is not signed with your account’s `apiSecret`, breaks the `iat` and `exp` rules, has expired or been revoked, or its account is not active. All of these answer the same.",{"code":652,"message":653,"status":654,"when":655},"forbidden","Insufficient role permissions",403,"The token is valid, but no role on your account allows `auth\u002Fsignin` on the organization in the path, or a role denies it.",{"code":652,"message":657,"status":654,"when":658},"Student is not activated for organization stem.","The student has no access to this organization: their `activatedPlatformsThisSeason` holds neither its `slug` nor `common`. Grant it with `updateOrgStudent`, then ask again.",{"code":660,"message":661,"status":662,"when":663},"not_found","Organization not found!",404,"`organizationId` is not the `_id` of an organization.",{"code":660,"message":665,"status":662,"when":666},"Student not found!","No student of yours has this `studentId`. A student registered by another account answers the same.",{"code":668,"message":669,"status":670,"when":671},"payload_too_large","request entity too large",413,"The body is larger than 100 kB.",{"code":673,"message":674,"status":675,"when":676},"unsupported_media_type","unsupported charset \"ISO-8859-1\"",415,"The body declares a charset that is not a UTF one (send UTF-8), or a `Content-Encoding` other than gzip, deflate or br.",{"code":678,"status":679,"when":680},"too_many_requests",429,"Your account has made more than 100 requests to this operation in the current 60-second window. Wait the seconds in `Retry-After` before sending again.",{"code":682,"status":683,"when":684},"internal_error",500,"Something failed on our side. Retry later, and quote `request_id` if it goes on.",{"code":682,"message":686,"status":683,"when":687},"Could not issue a sign-in token, please retry.","The link could not be issued. Send the request again.",[689],{"description":690,"example":691,"in":692,"name":693,"required":364,"schema":694},"The organization’s `_id`: 24 hexadecimal digits, as `listOrganizations` (`GET \u002Fv1\u002Forganization`) lists it.","64b7f0c2a1d3e4f5a6b7c8d9","path","organizationId",{"pattern":695,"type":696},"^[0-9a-f]{24}$","string",{"content":698,"required":364},{"application\u002Fjson":699},{"schema":700},{"x-ref":701,"description":702,"properties":703,"required":710,"type":712},"#\u002Fcomponents\u002Fschemas\u002FCreateSigninLinkRequest","The body of `createSigninLink`: the student to sign in, and where they land.",{"studentId":704,"redirect":707},{"description":705,"example":706,"type":696},"The id (`_id`) of the student to sign in, as `registerStudent` returned it. It must be one of your students.","6650a1b2c3d4e5f6a7b8c9d0",{"description":708,"example":709,"type":696},"Where the student lands once signed in: a path on the organization’s panel, starting with a single `\u002F`, with no whitespace and no backslash anywhere. Full URLs, `\u002F\u002Fhost` and `\u002F\\host` are refused, so a link can never send anyone off the panel. `{userId}` in the path is replaced with the student’s id on that organization. Leave it out to land on the organization’s `defaultRedirect`.","\u002Fdashboard",[711],"studentId","object",{"200":714,"400":794,"401":839,"403":861,"404":885,"413":908,"415":929,"429":950,"500":976},{"content":715,"description":783,"headers":784},{"application\u002Fjson":716},{"schema":717},{"allOf":718},[719,757],{"x-ref":720,"description":721,"properties":722,"required":754,"type":712},"#\u002Fcomponents\u002Fschemas\u002FSuccessEnvelope","How every successful JSON response is wrapped. `data` is the result, and each operation declares its shape; list operations add `pagination`. `GET \u002Fv1\u002Fapi-account\u002Fvalidate-me` is the one operation that answers without this envelope.",{"success":723,"message":727,"pagination":730},{"description":724,"enum":725,"example":364,"type":726},"Always `true` on a success.",[364],"boolean",{"description":728,"example":729,"type":696},"A sentence saying what happened, written for a person. Branch on the status and on `data`, not on this.","Request completed successfully.",{"allOf":731,"description":753},[732],{"x-ref":733,"description":734,"properties":735,"required":748,"type":712},"#\u002Fcomponents\u002Fschemas\u002FPaginationMeta","Where one page sits in the whole list.",{"page":736,"limit":739,"total":742,"totalPages":746},{"description":737,"example":367,"minimum":367,"type":738},"The page returned, counting from 1.","number",{"description":740,"example":478,"maximum":741,"minimum":367,"type":738},"Items per page: the `limit` you sent, 20 if you sent none, and never more than 100.",100,{"description":743,"example":744,"minimum":745,"type":738},"Items across every page.",57,0,{"description":747,"example":382,"minimum":745,"type":738},"Pages at this `limit`: `total \u002F limit`, rounded up.",[749,750,751,752],"page","limit","total","totalPages","On list operations only.",[755,756],"success","message",{"properties":758,"required":781,"type":712},{"message":759,"data":761},{"example":760,"type":696},"Sign-in link generated successfully.",{"x-ref":762,"description":763,"properties":764,"required":778,"type":712},"#\u002Fcomponents\u002Fschemas\u002FSigninLinkResponse","A link that signs one of your students in to an organization. It works once, within 120 seconds.",{"url":765,"organization":769,"studentId":772,"expiresIn":774},{"description":766,"example":767,"format":768,"type":696},"Send the student’s browser here to sign them in. It works once, and only within `expiresIn` seconds; after either, it answers that the access token is invalid or expired, and you make a new link. Treat it as a secret while it lives, and as opaque: do not build, parse or change it.","https:\u002F\u002Fauth.main-team.org\u002Fapi\u002Fuser\u002Foauth\u002Finvoke?accessToken=exampletokenexampletokenexampletoken&redirectUrl=%2Fdashboard","uri",{"description":770,"example":771,"type":696},"The `slug` of the organization the student lands in.","stem",{"description":773,"example":706,"type":696},"The id of the student the link signs in.",{"description":775,"example":776,"type":777},"Seconds the link stays usable from now: always 120.",120,"integer",[779,468,711,780],"url","expiresIn",[782],"data","Success: `message` is \"Sign-in link generated successfully.\".",{"X-RateLimit-Limit":785,"X-RateLimit-Remaining":788,"X-RateLimit-Reset":791},{"description":786,"schema":787},"Requests your account may make to this operation per window (100).",{"type":777},{"description":789,"schema":790},"Requests left in the current window.",{"type":777},{"description":792,"schema":793},"Seconds until the current window ends.",{"type":777},{"content":795,"description":838},{"application\u002Fjson":796},{"examples":797,"schema":807},{"bad_request":798,"bad_request_2":804},{"summary":643,"value":799},{"error":800},{"code":641,"documentation_url":801,"message":802,"request_id":803},"https:\u002F\u002Fhub.main-team.org\u002Fapi\u002Ferrors#bad_request","The request was malformed or contained invalid parameters.","0b5c6d0e-8f7a-4b1c-9d2e-3f4a5b6c7d8e",{"summary":646,"value":805},{"error":806},{"code":641,"documentation_url":801,"message":645,"request_id":803},{"x-ref":808,"description":809,"properties":810,"required":836,"type":712},"#\u002Fcomponents\u002Fschemas\u002FErrorEnvelope","How every error response is wrapped.",{"error":811},{"x-ref":812,"description":813,"properties":814,"required":832,"type":712},"#\u002Fcomponents\u002Fschemas\u002FErrorDetail","What went wrong.",{"code":815,"message":822,"documentation_url":825,"request_id":828,"details":830},{"description":816,"enum":817,"example":660,"type":696},"A stable machine code: branch on this. Each one is explained at `documentation_url`.",[818,641,648,652,660,819,668,673,820,678,682,821],"invalid_email","conflict","unprocessable_entity","service_unavailable",{"description":823,"example":824,"type":696},"Written for a person, and may change: never branch on it.","Not found!",{"description":826,"example":827,"format":768,"type":696},"Where this code is explained.","https:\u002F\u002Fhub.main-team.org\u002Fapi\u002Ferrors#not_found",{"description":829,"example":803,"type":696},"This request’s id, also sent as the `X-Request-Id` response header: the one you sent, when it was acceptable, or else one the API made. Quote it when you report a problem.",{"additionalProperties":364,"description":831,"type":712},"Present only where an operation says so, and then with the shape that operation documents — the rows it could not accept, say. Treat it as absent everywhere else, and ignore a `details` you do not recognise.",[833,756,834,835],"code","documentation_url","request_id",[837],"error","- `bad_request`: The body is not valid JSON, breaks a field’s rules, or has a field this operation does not accept (\"property \u003Cname> should not exist\").\n- `bad_request`: `redirect` is not a path on the panel: it needs one leading `\u002F`, and no whitespace or backslash anywhere.",{"content":840,"description":860},{"application\u002Fjson":841},{"examples":842,"schema":848},{"unauthorized":843},{"summary":648,"value":844},{"error":845},{"code":648,"documentation_url":846,"message":847,"request_id":803},"https:\u002F\u002Fhub.main-team.org\u002Fapi\u002Ferrors#unauthorized","Authentication is required or the provided credentials are invalid.",{"x-ref":808,"description":809,"properties":849,"required":859,"type":712},{"error":850},{"x-ref":812,"description":813,"properties":851,"required":858,"type":712},{"code":852,"message":854,"documentation_url":855,"request_id":856,"details":857},{"description":816,"enum":853,"example":660,"type":696},[818,641,648,652,660,819,668,673,820,678,682,821],{"description":823,"example":824,"type":696},{"description":826,"example":827,"format":768,"type":696},{"description":829,"example":803,"type":696},{"additionalProperties":364,"description":831,"type":712},[833,756,834,835],[837],"`unauthorized`: The token is missing or malformed, is not signed with your account’s `apiSecret`, breaks the `iat` and `exp` rules, has expired or been revoked, or its account is not active. All of these answer the same.",{"content":862,"description":884},{"application\u002Fjson":863},{"examples":864,"schema":872},{"forbidden":865,"forbidden_2":869},{"summary":655,"value":866},{"error":867},{"code":652,"documentation_url":868,"message":653,"request_id":803},"https:\u002F\u002Fhub.main-team.org\u002Fapi\u002Ferrors#forbidden",{"summary":658,"value":870},{"error":871},{"code":652,"documentation_url":868,"message":657,"request_id":803},{"x-ref":808,"description":809,"properties":873,"required":883,"type":712},{"error":874},{"x-ref":812,"description":813,"properties":875,"required":882,"type":712},{"code":876,"message":878,"documentation_url":879,"request_id":880,"details":881},{"description":816,"enum":877,"example":660,"type":696},[818,641,648,652,660,819,668,673,820,678,682,821],{"description":823,"example":824,"type":696},{"description":826,"example":827,"format":768,"type":696},{"description":829,"example":803,"type":696},{"additionalProperties":364,"description":831,"type":712},[833,756,834,835],[837],"- `forbidden`: The token is valid, but no role on your account allows `auth\u002Fsignin` on the organization in the path, or a role denies it.\n- `forbidden`: The student has no access to this organization: their `activatedPlatformsThisSeason` holds neither its `slug` nor `common`. Grant it with `updateOrgStudent`, then ask again.",{"content":886,"description":907},{"application\u002Fjson":887},{"examples":888,"schema":895},{"not_found":889,"not_found_2":892},{"summary":663,"value":890},{"error":891},{"code":660,"documentation_url":827,"message":661,"request_id":803},{"summary":666,"value":893},{"error":894},{"code":660,"documentation_url":827,"message":665,"request_id":803},{"x-ref":808,"description":809,"properties":896,"required":906,"type":712},{"error":897},{"x-ref":812,"description":813,"properties":898,"required":905,"type":712},{"code":899,"message":901,"documentation_url":902,"request_id":903,"details":904},{"description":816,"enum":900,"example":660,"type":696},[818,641,648,652,660,819,668,673,820,678,682,821],{"description":823,"example":824,"type":696},{"description":826,"example":827,"format":768,"type":696},{"description":829,"example":803,"type":696},{"additionalProperties":364,"description":831,"type":712},[833,756,834,835],[837],"- `not_found`: `organizationId` is not the `_id` of an organization.\n- `not_found`: No student of yours has this `studentId`. A student registered by another account answers the same.",{"content":909,"description":928},{"application\u002Fjson":910},{"examples":911,"schema":916},{"payload_too_large":912},{"summary":668,"value":913},{"error":914},{"code":668,"documentation_url":915,"message":669,"request_id":803},"https:\u002F\u002Fhub.main-team.org\u002Fapi\u002Ferrors#payload_too_large",{"x-ref":808,"description":809,"properties":917,"required":927,"type":712},{"error":918},{"x-ref":812,"description":813,"properties":919,"required":926,"type":712},{"code":920,"message":922,"documentation_url":923,"request_id":924,"details":925},{"description":816,"enum":921,"example":660,"type":696},[818,641,648,652,660,819,668,673,820,678,682,821],{"description":823,"example":824,"type":696},{"description":826,"example":827,"format":768,"type":696},{"description":829,"example":803,"type":696},{"additionalProperties":364,"description":831,"type":712},[833,756,834,835],[837],"`payload_too_large`: The body is larger than 100 kB.",{"content":930,"description":949},{"application\u002Fjson":931},{"examples":932,"schema":937},{"unsupported_media_type":933},{"summary":673,"value":934},{"error":935},{"code":673,"documentation_url":936,"message":674,"request_id":803},"https:\u002F\u002Fhub.main-team.org\u002Fapi\u002Ferrors#unsupported_media_type",{"x-ref":808,"description":809,"properties":938,"required":948,"type":712},{"error":939},{"x-ref":812,"description":813,"properties":940,"required":947,"type":712},{"code":941,"message":943,"documentation_url":944,"request_id":945,"details":946},{"description":816,"enum":942,"example":660,"type":696},[818,641,648,652,660,819,668,673,820,678,682,821],{"description":823,"example":824,"type":696},{"description":826,"example":827,"format":768,"type":696},{"description":829,"example":803,"type":696},{"additionalProperties":364,"description":831,"type":712},[833,756,834,835],[837],"`unsupported_media_type`: The body declares a charset that is not a UTF one (send UTF-8), or a `Content-Encoding` other than gzip, deflate or br.",{"content":951,"description":971,"headers":972},{"application\u002Fjson":952},{"examples":953,"schema":959},{"too_many_requests":954},{"summary":678,"value":955},{"error":956},{"code":678,"documentation_url":957,"message":958,"request_id":803},"https:\u002F\u002Fhub.main-team.org\u002Fapi\u002Ferrors#too_many_requests","Too many requests to this operation. Wait the number of seconds in Retry-After, then try again.",{"x-ref":808,"description":809,"properties":960,"required":970,"type":712},{"error":961},{"x-ref":812,"description":813,"properties":962,"required":969,"type":712},{"code":963,"message":965,"documentation_url":966,"request_id":967,"details":968},{"description":816,"enum":964,"example":660,"type":696},[818,641,648,652,660,819,668,673,820,678,682,821],{"description":823,"example":824,"type":696},{"description":826,"example":827,"format":768,"type":696},{"description":829,"example":803,"type":696},{"additionalProperties":364,"description":831,"type":712},[833,756,834,835],[837],"`too_many_requests`: Your account has made more than 100 requests to this operation in the current 60-second window. Wait the seconds in `Retry-After` before sending again.",{"Retry-After":973},{"description":974,"schema":975},"Seconds to wait before sending again; a request sent sooner is refused too.",{"type":777},{"content":977,"description":1000},{"application\u002Fjson":978},{"examples":979,"schema":988},{"internal_error":980,"internal_error_2":985},{"summary":684,"value":981},{"error":982},{"code":682,"documentation_url":983,"message":984,"request_id":803},"https:\u002F\u002Fhub.main-team.org\u002Fapi\u002Ferrors#internal_error","An unexpected error occurred.",{"summary":687,"value":986},{"error":987},{"code":682,"documentation_url":983,"message":686,"request_id":803},{"x-ref":808,"description":809,"properties":989,"required":999,"type":712},{"error":990},{"x-ref":812,"description":813,"properties":991,"required":998,"type":712},{"code":992,"message":994,"documentation_url":995,"request_id":996,"details":997},{"description":816,"enum":993,"example":660,"type":696},[818,641,648,652,660,819,668,673,820,678,682,821],{"description":823,"example":824,"type":696},{"description":826,"example":827,"format":768,"type":696},{"description":829,"example":803,"type":696},{"additionalProperties":364,"description":831,"type":712},[833,756,834,835],[837],"- `internal_error`: Something failed on our side. Retry later, and quote `request_id` if it goes on.\n- `internal_error`: The link could not be issued. Send the request again.","200","envelope",{"path":26},{"id":1005,"title":210,"apiPath":490,"body":1006,"deprecated":134,"description":1717,"extension":1718,"meta":1719,"method":141,"navigation":364,"operationId":488,"order":1720,"path":211,"permission":462,"public":134,"seo":1721,"stem":1722,"summary":210,"tag":80,"__hash__":1723},"apiReference\u002Fapi\u002Freference\u002Fcreate-signin-link.md",{"type":1007,"value":1008,"toc":1715},"minimark",[1009,1711],[1010,1011,1012,1118,1376],"api-code-group",{},[1013,1014,1020],"pre",{"className":1015,"code":1016,"filename":1017,"language":1018,"meta":1019,"style":1019},"language-bash shiki shiki-themes github-light-high-contrast github-dark-high-contrast","# $TOKEN: a short-lived token you minted with your API key and secret\ncurl -sS -X POST 'https:\u002F\u002Fapi.main-team.org\u002Fv1\u002F\u003CorganizationId>\u002Fauth\u002Fsignin' \\\n  -H \"Authorization: Bearer $TOKEN\" \\\n  -H 'Content-Type: application\u002Fjson' \\\n  --data-binary @- \u003C\u003C'JSON'\n{\n  \"studentId\": \"6650a1b2c3d4e5f6a7b8c9d0\",\n  \"redirect\": \"\u002Fdashboard\"\n}\nJSON\n","curl","bash","",[833,1021,1022,1030,1053,1070,1079,1093,1098,1103,1108,1113],{"__ignoreMap":1019},[1023,1024,1026],"span",{"class":1025,"line":367},"line",[1023,1027,1029],{"class":1028},"sLBg1","# $TOKEN: a short-lived token you minted with your API key and secret\n",[1023,1031,1032,1035,1039,1042,1046,1049],{"class":1025,"line":377},[1023,1033,1017],{"class":1034},"soyes",[1023,1036,1038],{"class":1037},"s-5SL"," -sS",[1023,1040,1041],{"class":1037}," -X",[1023,1043,1045],{"class":1044},"sT6z2"," POST",[1023,1047,1048],{"class":1044}," 'https:\u002F\u002Fapi.main-team.org\u002Fv1\u002F\u003CorganizationId>\u002Fauth\u002Fsignin'",[1023,1050,1052],{"class":1051},"sHUrx"," \\\n",[1023,1054,1055,1058,1061,1065,1068],{"class":1025,"line":382},[1023,1056,1057],{"class":1037},"  -H",[1023,1059,1060],{"class":1044}," \"Authorization: Bearer ",[1023,1062,1064],{"class":1063},"suds8","$TOKEN",[1023,1066,1067],{"class":1044},"\"",[1023,1069,1052],{"class":1051},[1023,1071,1072,1074,1077],{"class":1025,"line":391},[1023,1073,1057],{"class":1037},[1023,1075,1076],{"class":1044}," 'Content-Type: application\u002Fjson'",[1023,1078,1052],{"class":1051},[1023,1080,1081,1084,1087,1090],{"class":1025,"line":396},[1023,1082,1083],{"class":1037},"  --data-binary",[1023,1085,1086],{"class":1044}," @-",[1023,1088,1089],{"class":1051}," \u003C\u003C",[1023,1091,1092],{"class":1063},"'JSON'\n",[1023,1094,1095],{"class":1025,"line":402},[1023,1096,1097],{"class":1044},"{\n",[1023,1099,1100],{"class":1025,"line":407},[1023,1101,1102],{"class":1044},"  \"studentId\": \"6650a1b2c3d4e5f6a7b8c9d0\",\n",[1023,1104,1105],{"class":1025,"line":413},[1023,1106,1107],{"class":1044},"  \"redirect\": \"\u002Fdashboard\"\n",[1023,1109,1110],{"class":1025,"line":418},[1023,1111,1112],{"class":1044},"}\n",[1023,1114,1115],{"class":1025,"line":427},[1023,1116,1117],{"class":1063},"JSON\n",[1013,1119,1123],{"className":1120,"code":1121,"filename":308,"language":1122,"meta":1019,"style":1019},"language-js shiki shiki-themes github-light-high-contrast github-dark-high-contrast","const token = process.env.TOKEN; \u002F\u002F a short-lived token you minted with your API key and secret\n\nconst res = await fetch('https:\u002F\u002Fapi.main-team.org\u002Fv1\u002F\u003CorganizationId>\u002Fauth\u002Fsignin', {\n  method: 'POST',\n  headers: {\n    Authorization: `Bearer ${token}`,\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    \"studentId\": \"6650a1b2c3d4e5f6a7b8c9d0\",\n    \"redirect\": \"\u002Fdashboard\"\n  }),\n});\nconst body = await res.json();\nif (!res.ok) throw new Error(`${res.status} ${body.error.code}: ${body.error.message}`);\nconsole.log(body.data);\n","js",[833,1124,1125,1148,1153,1178,1189,1194,1210,1223,1228,1245,1257,1267,1272,1277,1297,1365],{"__ignoreMap":1019},[1023,1126,1127,1130,1133,1136,1139,1142,1145],{"class":1025,"line":367},[1023,1128,1129],{"class":1051},"const",[1023,1131,1132],{"class":1037}," token",[1023,1134,1135],{"class":1051}," =",[1023,1137,1138],{"class":1063}," process.env.",[1023,1140,1141],{"class":1037},"TOKEN",[1023,1143,1144],{"class":1063},"; ",[1023,1146,1147],{"class":1028},"\u002F\u002F a short-lived token you minted with your API key and secret\n",[1023,1149,1150],{"class":1025,"line":377},[1023,1151,1152],{"emptyLinePlaceholder":364},"\n",[1023,1154,1155,1157,1160,1162,1165,1169,1172,1175],{"class":1025,"line":382},[1023,1156,1129],{"class":1051},[1023,1158,1159],{"class":1037}," res",[1023,1161,1135],{"class":1051},[1023,1163,1164],{"class":1051}," await",[1023,1166,1168],{"class":1167},"sKwhi"," fetch",[1023,1170,1171],{"class":1063},"(",[1023,1173,1174],{"class":1044},"'https:\u002F\u002Fapi.main-team.org\u002Fv1\u002F\u003CorganizationId>\u002Fauth\u002Fsignin'",[1023,1176,1177],{"class":1063},", {\n",[1023,1179,1180,1183,1186],{"class":1025,"line":391},[1023,1181,1182],{"class":1063},"  method: ",[1023,1184,1185],{"class":1044},"'POST'",[1023,1187,1188],{"class":1063},",\n",[1023,1190,1191],{"class":1025,"line":396},[1023,1192,1193],{"class":1063},"  headers: {\n",[1023,1195,1196,1199,1202,1205,1208],{"class":1025,"line":402},[1023,1197,1198],{"class":1063},"    Authorization: ",[1023,1200,1201],{"class":1044},"`Bearer ${",[1023,1203,1204],{"class":1063},"token",[1023,1206,1207],{"class":1044},"}`",[1023,1209,1188],{"class":1063},[1023,1211,1212,1215,1218,1221],{"class":1025,"line":407},[1023,1213,1214],{"class":1044},"    'Content-Type'",[1023,1216,1217],{"class":1063},": ",[1023,1219,1220],{"class":1044},"'application\u002Fjson'",[1023,1222,1188],{"class":1063},[1023,1224,1225],{"class":1025,"line":413},[1023,1226,1227],{"class":1063},"  },\n",[1023,1229,1230,1233,1236,1239,1242],{"class":1025,"line":418},[1023,1231,1232],{"class":1063},"  body: ",[1023,1234,1235],{"class":1037},"JSON",[1023,1237,1238],{"class":1063},".",[1023,1240,1241],{"class":1167},"stringify",[1023,1243,1244],{"class":1063},"({\n",[1023,1246,1247,1250,1252,1255],{"class":1025,"line":427},[1023,1248,1249],{"class":1044},"    \"studentId\"",[1023,1251,1217],{"class":1063},[1023,1253,1254],{"class":1044},"\"6650a1b2c3d4e5f6a7b8c9d0\"",[1023,1256,1188],{"class":1063},[1023,1258,1259,1262,1264],{"class":1025,"line":432},[1023,1260,1261],{"class":1044},"    \"redirect\"",[1023,1263,1217],{"class":1063},[1023,1265,1266],{"class":1044},"\"\u002Fdashboard\"\n",[1023,1268,1269],{"class":1025,"line":437},[1023,1270,1271],{"class":1063},"  }),\n",[1023,1273,1274],{"class":1025,"line":442},[1023,1275,1276],{"class":1063},"});\n",[1023,1278,1279,1281,1284,1286,1288,1291,1294],{"class":1025,"line":447},[1023,1280,1129],{"class":1051},[1023,1282,1283],{"class":1037}," body",[1023,1285,1135],{"class":1051},[1023,1287,1164],{"class":1051},[1023,1289,1290],{"class":1063}," res.",[1023,1292,1293],{"class":1167},"json",[1023,1295,1296],{"class":1063},"();\n",[1023,1298,1299,1302,1305,1308,1311,1314,1317,1320,1322,1325,1328,1330,1333,1336,1339,1341,1343,1345,1347,1350,1352,1354,1356,1358,1360,1362],{"class":1025,"line":452},[1023,1300,1301],{"class":1051},"if",[1023,1303,1304],{"class":1063}," (",[1023,1306,1307],{"class":1051},"!",[1023,1309,1310],{"class":1063},"res.ok) ",[1023,1312,1313],{"class":1051},"throw",[1023,1315,1316],{"class":1051}," new",[1023,1318,1319],{"class":1167}," Error",[1023,1321,1171],{"class":1063},[1023,1323,1324],{"class":1044},"`${",[1023,1326,1327],{"class":1063},"res",[1023,1329,1238],{"class":1044},[1023,1331,1332],{"class":1063},"status",[1023,1334,1335],{"class":1044},"} ${",[1023,1337,1338],{"class":1063},"body",[1023,1340,1238],{"class":1044},[1023,1342,837],{"class":1063},[1023,1344,1238],{"class":1044},[1023,1346,833],{"class":1063},[1023,1348,1349],{"class":1044},"}: ${",[1023,1351,1338],{"class":1063},[1023,1353,1238],{"class":1044},[1023,1355,837],{"class":1063},[1023,1357,1238],{"class":1044},[1023,1359,756],{"class":1063},[1023,1361,1207],{"class":1044},[1023,1363,1364],{"class":1063},");\n",[1023,1366,1367,1370,1373],{"class":1025,"line":457},[1023,1368,1369],{"class":1063},"console.",[1023,1371,1372],{"class":1167},"log",[1023,1374,1375],{"class":1063},"(body.data);\n",[1013,1377,1381],{"className":1378,"code":1379,"filename":311,"language":1380,"meta":1019,"style":1019},"language-php shiki shiki-themes github-light-high-contrast github-dark-high-contrast","\u003C?php\n$token = getenv('TOKEN'); \u002F\u002F a short-lived token you minted with your API key and secret\n\n$ch = curl_init('https:\u002F\u002Fapi.main-team.org\u002Fv1\u002F\u003CorganizationId>\u002Fauth\u002Fsignin');\ncurl_setopt_array($ch, [\n    CURLOPT_CUSTOMREQUEST => 'POST',\n    CURLOPT_HTTPHEADER => [\n        'Authorization: Bearer ' . $token,\n        'Content-Type: application\u002Fjson',\n    ],\n    CURLOPT_POSTFIELDS => json_encode([\n        'studentId' => '6650a1b2c3d4e5f6a7b8c9d0',\n        'redirect' => '\u002Fdashboard',\n    ]),\n    CURLOPT_RETURNTRANSFER => true,\n]);\n$response = curl_exec($ch);\nif ($response === false) {\n    throw new RuntimeException(curl_error($ch));\n}\n$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);\n$body = json_decode($response, true);\nif ($status >= 400) {\n    $error = $body['error'];\n    throw new RuntimeException(\"$status {$error['code']}: {$error['message']}\");\n}\nprint_r($body['data']);\n","php",[833,1382,1383,1391,1412,1416,1432,1440,1453,1463,1474,1481,1486,1499,1511,1523,1528,1540,1545,1558,1574,1592,1596,1614,1632,1647,1663,1694,1698],{"__ignoreMap":1019},[1023,1384,1385,1388],{"class":1025,"line":367},[1023,1386,1387],{"class":1051},"\u003C?",[1023,1389,1390],{"class":1037},"php\n",[1023,1392,1393,1396,1399,1402,1404,1407,1410],{"class":1025,"line":377},[1023,1394,1395],{"class":1063},"$token ",[1023,1397,1398],{"class":1051},"=",[1023,1400,1401],{"class":1037}," getenv",[1023,1403,1171],{"class":1063},[1023,1405,1406],{"class":1044},"'TOKEN'",[1023,1408,1409],{"class":1063},"); ",[1023,1411,1147],{"class":1028},[1023,1413,1414],{"class":1025,"line":382},[1023,1415,1152],{"emptyLinePlaceholder":364},[1023,1417,1418,1421,1423,1426,1428,1430],{"class":1025,"line":391},[1023,1419,1420],{"class":1063},"$ch ",[1023,1422,1398],{"class":1051},[1023,1424,1425],{"class":1037}," curl_init",[1023,1427,1171],{"class":1063},[1023,1429,1174],{"class":1044},[1023,1431,1364],{"class":1063},[1023,1433,1434,1437],{"class":1025,"line":396},[1023,1435,1436],{"class":1037},"curl_setopt_array",[1023,1438,1439],{"class":1063},"($ch, [\n",[1023,1441,1442,1445,1448,1451],{"class":1025,"line":402},[1023,1443,1444],{"class":1037},"    CURLOPT_CUSTOMREQUEST",[1023,1446,1447],{"class":1051}," =>",[1023,1449,1450],{"class":1044}," 'POST'",[1023,1452,1188],{"class":1063},[1023,1454,1455,1458,1460],{"class":1025,"line":407},[1023,1456,1457],{"class":1037},"    CURLOPT_HTTPHEADER",[1023,1459,1447],{"class":1051},[1023,1461,1462],{"class":1063}," [\n",[1023,1464,1465,1468,1471],{"class":1025,"line":413},[1023,1466,1467],{"class":1044},"        'Authorization: Bearer '",[1023,1469,1470],{"class":1051}," .",[1023,1472,1473],{"class":1063}," $token,\n",[1023,1475,1476,1479],{"class":1025,"line":418},[1023,1477,1478],{"class":1044},"        'Content-Type: application\u002Fjson'",[1023,1480,1188],{"class":1063},[1023,1482,1483],{"class":1025,"line":427},[1023,1484,1485],{"class":1063},"    ],\n",[1023,1487,1488,1491,1493,1496],{"class":1025,"line":432},[1023,1489,1490],{"class":1037},"    CURLOPT_POSTFIELDS",[1023,1492,1447],{"class":1051},[1023,1494,1495],{"class":1037}," json_encode",[1023,1497,1498],{"class":1063},"([\n",[1023,1500,1501,1504,1506,1509],{"class":1025,"line":437},[1023,1502,1503],{"class":1044},"        'studentId'",[1023,1505,1447],{"class":1051},[1023,1507,1508],{"class":1044}," '6650a1b2c3d4e5f6a7b8c9d0'",[1023,1510,1188],{"class":1063},[1023,1512,1513,1516,1518,1521],{"class":1025,"line":442},[1023,1514,1515],{"class":1044},"        'redirect'",[1023,1517,1447],{"class":1051},[1023,1519,1520],{"class":1044}," '\u002Fdashboard'",[1023,1522,1188],{"class":1063},[1023,1524,1525],{"class":1025,"line":447},[1023,1526,1527],{"class":1063},"    ]),\n",[1023,1529,1530,1533,1535,1538],{"class":1025,"line":452},[1023,1531,1532],{"class":1037},"    CURLOPT_RETURNTRANSFER",[1023,1534,1447],{"class":1051},[1023,1536,1537],{"class":1037}," true",[1023,1539,1188],{"class":1063},[1023,1541,1542],{"class":1025,"line":457},[1023,1543,1544],{"class":1063},"]);\n",[1023,1546,1547,1550,1552,1555],{"class":1025,"line":463},[1023,1548,1549],{"class":1063},"$response ",[1023,1551,1398],{"class":1051},[1023,1553,1554],{"class":1037}," curl_exec",[1023,1556,1557],{"class":1063},"($ch);\n",[1023,1559,1560,1562,1565,1568,1571],{"class":1025,"line":469},[1023,1561,1301],{"class":1051},[1023,1563,1564],{"class":1063}," ($response ",[1023,1566,1567],{"class":1051},"===",[1023,1569,1570],{"class":1037}," false",[1023,1572,1573],{"class":1063},") {\n",[1023,1575,1576,1579,1581,1584,1586,1589],{"class":1025,"line":474},[1023,1577,1578],{"class":1051},"    throw",[1023,1580,1316],{"class":1051},[1023,1582,1583],{"class":1037}," RuntimeException",[1023,1585,1171],{"class":1063},[1023,1587,1588],{"class":1037},"curl_error",[1023,1590,1591],{"class":1063},"($ch));\n",[1023,1593,1594],{"class":1025,"line":478},[1023,1595,1112],{"class":1063},[1023,1597,1598,1601,1603,1606,1609,1612],{"class":1025,"line":483},[1023,1599,1600],{"class":1063},"$status ",[1023,1602,1398],{"class":1051},[1023,1604,1605],{"class":1037}," curl_getinfo",[1023,1607,1608],{"class":1063},"($ch, ",[1023,1610,1611],{"class":1037},"CURLINFO_RESPONSE_CODE",[1023,1613,1364],{"class":1063},[1023,1615,1616,1619,1621,1624,1627,1630],{"class":1025,"line":491},[1023,1617,1618],{"class":1063},"$body ",[1023,1620,1398],{"class":1051},[1023,1622,1623],{"class":1037}," json_decode",[1023,1625,1626],{"class":1063},"($response, ",[1023,1628,1629],{"class":1037},"true",[1023,1631,1364],{"class":1063},[1023,1633,1634,1636,1639,1642,1645],{"class":1025,"line":500},[1023,1635,1301],{"class":1051},[1023,1637,1638],{"class":1063}," ($status ",[1023,1640,1641],{"class":1051},">=",[1023,1643,1644],{"class":1037}," 400",[1023,1646,1573],{"class":1063},[1023,1648,1649,1652,1654,1657,1660],{"class":1025,"line":506},[1023,1650,1651],{"class":1063},"    $error ",[1023,1653,1398],{"class":1051},[1023,1655,1656],{"class":1063}," $body[",[1023,1658,1659],{"class":1044},"'error'",[1023,1661,1662],{"class":1063},"];\n",[1023,1664,1665,1667,1669,1671,1673,1675,1678,1681,1684,1687,1689,1692],{"class":1025,"line":511},[1023,1666,1578],{"class":1051},[1023,1668,1316],{"class":1051},[1023,1670,1583],{"class":1037},[1023,1672,1171],{"class":1063},[1023,1674,1067],{"class":1044},[1023,1676,1677],{"class":1063},"$status",[1023,1679,1680],{"class":1044}," {",[1023,1682,1683],{"class":1063},"$error",[1023,1685,1686],{"class":1044},"['code']}: {",[1023,1688,1683],{"class":1063},[1023,1690,1691],{"class":1044},"['message']}\"",[1023,1693,1364],{"class":1063},[1023,1695,1696],{"class":1025,"line":516},[1023,1697,1112],{"class":1063},[1023,1699,1700,1703,1706,1709],{"class":1025,"line":521},[1023,1701,1702],{"class":1037},"print_r",[1023,1704,1705],{"class":1063},"($body[",[1023,1707,1708],{"class":1044},"'data'",[1023,1710,1544],{"class":1063},[1712,1713,1714],"style",{},"html pre.shiki code .sLBg1, html code.shiki .sLBg1{--shiki-default:#66707B;--shiki-dark:#BDC4CC}html pre.shiki code .soyes, html code.shiki .soyes{--shiki-default:#702C00;--shiki-dark:#FFB757}html pre.shiki code .s-5SL, html code.shiki .s-5SL{--shiki-default:#023B95;--shiki-dark:#91CBFF}html pre.shiki code .sT6z2, html code.shiki .sT6z2{--shiki-default:#032563;--shiki-dark:#ADDCFF}html pre.shiki code .sHUrx, html code.shiki .sHUrx{--shiki-default:#A0111F;--shiki-dark:#FF9492}html pre.shiki code .suds8, html code.shiki .suds8{--shiki-default:#0E1116;--shiki-dark:#F0F3F6}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sKwhi, html code.shiki .sKwhi{--shiki-default:#622CBC;--shiki-dark:#DBB7FF}",{"title":1019,"searchDepth":377,"depth":382,"links":1716},[],"Returns a URL that signs the student in to this organization’s student panel.","md",{},"22",{"title":210,"description":1717},"api\u002Freference\u002Fcreate-signin-link","jlnkgGcZ9LMnvzk5KIFh9DgontntpY5_wwLCF9NDw8U",1791554613402]