PaginatedOneRosterUserProfileOutput

Paginated list of OneRoster user profiles

  • 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

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

    Array of user profile objects

    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.

    • dateCreated
      Type: stringFormat: date-time

      Date when the profile was created

    • description
      Type: string | null

      Human-readable description of this profile