getstudentuser.md

GetStudentUser

Example Usage

import { GetStudentUser } from "@superbuilders/oneroster/models/operations";

let value: GetStudentUser = {
  sourcedId: "<id>",
  status: "tobedeleted",
  enabledUser: true,
  givenName: "<value>",
  familyName: "<value>",
  roles: [
    {
      roleType: "primary",
      role: "relative",
      org: {
        href: "https://self-assured-deer.info/",
        sourcedId: "<id>",
        type: "<value>",
      },
      beginDate: null,
      endDate: "<value>",
    },
  ],
  agents: [
    {
      href: "https://infatuated-status.name/",
      sourcedId: "<id>",
      type: "category",
    },
  ],
};

Fields

Field	Type	Required	Description
sourcedId	string	✔️	N/A
status	operations.GetStudentStatus	✔️	N/A
dateLastModified	Date	➖	N/A
metadata	Record<string, any>	➖	N/A
userMasterIdentifier	string	➖	N/A
username	string	➖	N/A
userIds	operations.GetStudentUserId[]	➖	N/A
enabledUser	boolean	✔️	N/A
givenName	string	✔️	N/A
familyName	string	✔️	N/A
middleName	string	➖	N/A
roles	operations.GetStudentRole[]	✔️	N/A
agents	operations.GetStudentAgent[]	✔️	N/A
primaryOrg	operations.GetStudentPrimaryOrg	➖	N/A
email	string	➖	N/A
preferredFirstName	string	➖	N/A
preferredMiddleName	string	➖	N/A
preferredLastName	string	➖	N/A
pronouns	string	➖	N/A
grades	string[]	➖	N/A
password	string	➖	N/A
sms	string	➖	N/A
phone	string	➖	N/A
demographics	components.Demographics	➖	N/A