OneRosterUserInput

User information to be created or updated

  • user
    Type: object
    required
    • email
      Type: stringFormat: email
      required

      User's email address

    • enabledUser
      Type: stringenum
      required

      Whether the user account is enabled

      values
      • true
      • false
    • familyName
      Type: string
      required

      User's last name

    • givenName
      Type: string
      required

      User's first name

    • grades
      Type: array string[]
      required

      Grade levels for the user

    • primaryOrg
      Type: object
      required
    • sourcedId
      Type: stringFormat: uuid
      required

      Unique identifier for the user

    • status
      Type: stringenum
      required

      Status of the user record

      values
      • active
      • tobedeleted
      • inactive
    • demographics
      Type: object

      Demographic information for the user

    • identifier
      Type: string | null

      Additional identifier for the user

    • metadata
      Type: object | null

      Additional metadata for the user

    • middleName
      Type: string | null

      User's middle name

    • password
      Type: string | null

      User's password

    • phone
      Type: string | null

      User's phone number

    • preferredFirstName
      Type: string | null

      User's preferred first name

    • preferredLastName
      Type: string | null

      User's preferred last name

    • preferredMiddleName
      Type: string | null

      User's preferred middle name

    • pronouns
      Type: string | null

      User's preferred pronouns

    • roles
      Type: array object[]

      Roles to be assigned to the user

    • sms
      Type: string | null

      User's SMS number

    • userMasterIdentifier
      Type: string | null

      Master identifier for the user

    • username
      Type: string | null

      Username for the user