OneRosterUserOutput

User information in the OneRoster format

  • agents
    Type: array object[] · OneRosterGUIDRef[]
    required

    Array of agents (parents, guardians) associated with the user

    A reference to another OneRoster entity

    • href
      Type: stringFormat: uri
      required

      URI reference to the entity

    • sourcedId
      Type: string
      required

      Unique identifier of the referenced entity

    • type
      Type: stringenum
      required

      Type of the referenced entity

      values
      • academicSession
      • category
      • class
      • course
      • demographics
  • dateLastModified
    Type: stringFormat: date-time
    required

    Timestamp of when the user was last modified

  • email
    Type: string
    required

    User's email address

  • enabledUser
    Type: stringenum
    required

    This is used to determine whether or not the record is active in the local system.

    values
    • true
    • false
  • familyName
    Type: string
    required

    The family name. Also, known as the last name.

  • givenName
    Type: string
    required

    The given name. Also, known as the first name.

  • grades
    Type: array string[]
    required

    Array of grade levels associated with the user

  • resources
    Type: array object[] · OneRosterGUIDRef[]
    required

    The identifiers (GUIDs) for the set of resources that are to be made available to the user.

    A reference to another OneRoster entity

    • href
      Type: stringFormat: uri
      required

      URI reference to the entity

    • sourcedId
      Type: string
      required

      Unique identifier of the referenced entity

    • type
      Type: stringenum
      required

      Type of the referenced entity

      values
      • academicSession
      • category
      • class
      • course
      • demographics
  • roles
    Type: array object[] · OneRosterUserRoleOutput[]
    required

    Array of roles assigned to the user

    Role information associated with a user

    • org
      Type: object
      required

      Organization associated with the role

    • role
      Type: stringenum
      required

      Role value

      values
      • aide
      • counselor
      • districtAdministrator
      • guardian
      • parent
    • roleType
      Type: stringenum
      required

      Type of role (primary/secondary)

      values
      • primary
      • secondary
    • beginDate
      Type: string | null

      Date when the role assignment begins

    • endDate
      Type: string | null

      Date when the role assignment ends

    • userProfile
      Type: string | null

      User profile ID associated with this role

  • sourcedId
    Type: string
    required

    Unique identifier for the user

  • status
    Type: stringenum
    required

    Status of an entity in the system

    values
    • active
    • tobedeleted
    • inactive
  • userIds
    Type: array string[]
    required

    The set of external user identifiers that should be used for this user.

  • userProfiles
    Type: array object[] · OneRosterUserProfileOutput[]
    required

    Array of profiles associated with the user in different systems

    Profile information associated with a user in a specific role

    • profileId
      Type: stringFormat: uri
      required

      Unique identifier for the profile

    • profileType
      Type: string
      required

      Type of profile (e.g., learning platform, assessment system)

    • vendorId
      Type: string
      required

      Identifier of the vendor providing this profile

    • applicationId
      Type: string | null

      Identifier of the specific application this profile is for

    • credentials
      Type: array object[] · OneRosterCredentialOutput[]

      List of credentials associated with this profile

      The container for the information about a User Profile that will provide the user with access to some system, application, etc.

    • description
      Type: string | null

      Human-readable description of this profile

  • identifier
    Type: string | null

    Additional identifier for the user

  • metadata
    Type: object | null

    Additional metadata associated with the user

    • propertyName
      Type: anything
  • middleName
    Type: string | null

    The set of middle names. If more than one middle name is needed separate using a space.

  • password
    Type: string | null

    User's password (hashed)

  • phone
    Type: string | null

    User's primary phone number

  • preferredFirstName
    Type: string | null

    User's preferred first name if different from given name

  • preferredLastName
    Type: string | null

    User's preferred last name if different from family name

  • preferredMiddleName
    Type: string | null

    User's preferred middle name if different from middle name

  • primaryOrg
    Type: object

    ID of the user's primary organization

    • href
      Type: stringFormat: uri
      required

      URI reference to the entity

    • sourcedId
      Type: string
      required

      Unique identifier of the referenced entity

    • type
      Type: stringenum
      required

      Type of the referenced entity

      values
      • academicSession
      • category
      • class
      • course
      • demographics
  • sms
    Type: string | null

    User's SMS contact number

  • userMasterIdentifier
    Type: string | null

    The master unique identifier for this user. This is NOT the same as the user's interoperability 'sourcedId'.

  • username
    Type: string | null

    The user name assigned to the user.