PaginatedOneRosterUserOutput

Paginated list of OneRoster users

  • limit
    Type: integer
    required

    Maximum number of items returned

  • offset
    Type: integer
    required

    Number of items skipped in the result set

  • total
    Type: integer
    required

    Total number of items available

  • users
    Type: array object[] · OneRosterUserOutput[]
    required

    Array of user objects

    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

    • 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

    • roles
      Type: array object[] · OneRosterUserRoleOutput[]
      required

      Array of roles assigned to the user

      Role information associated with a user

    • 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

    • identifier
      Type: string | null

      Additional identifier for the user

    • metadata
      Type: object | null

      Additional metadata associated with the user

    • 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

    • 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.