Brightspace Data Sets for Users

Brightspace Data Sets for Users include:

These data sets do not depend on specific tools being turned on.

Entity Relationship Diagram

To show the relationships between entities used to create Brightspace Data Sets for Users, click the following thumbnail image:

Entity Relationship Diagram for Users

 

Brightspace Data Set: User Enrollments

About

Returns a list of enrollments for all users in your organization.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

1.0

OrgUnitId

Unique org unit identifier

Integer

4

PK

FK

1.0

UserId

Unique user identifier

Integer

4

PK

FK

1.0

RoleName

Role name

nvarchar

40

 

1.0

EnrollmentDate

Date enrolled (UTC)

DateTime

8

 

1.0

EnrollmentType

Enrollment type

String

27

 

1.2 - Added RoleId Unique role identifier Integer 4  

 

Brightspace Data Set: User Logins

About

Returns a list of all login attempts for your organization. The User Logins data set and differentials are limited to 3 years of data (all of the previous two calendar years and the current calendar year to date).

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

1.0

OrgId

Unique org unit Identifier

Integer

4

 

1.0

UserId

Unique user identifier. Field can be null.

Integer

4

FK

1.0

UserName

User name

nvarchar

512

 

1.0

IP

IP address

varchar

64

 

2.5/3.0 - Removed FK

SessionId

Unique session identifier. Field can be null.

Integer

4

 

1.0

StatusType

Login status

varchar

50

 

1.0

AttemptDate

Attempt date (UTC)

DateTime

8

 

1.0

ImpersonatingUserId

User ID of impersonator. Field can be null.

Integer

4

FK

1.0

TimeOff

Time elapsed in seconds since the last time a user logged in. Field can be null.

Integer

4

 

1.4 - Added LoginAttemptId Unique login attempt identifier BigInteger 8 PK

 

Brightspace Data Set: Users

About

Returns a list of users in your organization.

Version 4.10 / 5.4 adds a system user entry with UserId = 0 to this data set. The system user is only included in the full CSV.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

1.0

UserId

Unique user identifier

Integer

4

PK

1.0

UserName

User name

nvarchar

540

 

4.9 / 5.3 - Corrected column size

OrgDefinedId

Org defined ID. Field can be null.

nvarchar

256

 

1.0

FirstName

First name

nvarchar

128

 

1.0

MiddleName

Middle name. Field can be null.

nvarchar

128

 

1.0

LastName

Last name

nvarchar

128

 

1.0

IsActive

Is user active

Boolean

1

 

1.0

Organization

Organization name

String

100

 

1.0

ExternalEmail

External email address. Field can be null.

nvarchar

512

 

1.0

SignupDate

Date the user was created in the system (UTC).

DateTime

8

 

3.0 - Added FirstLoginDate Date when the user first logged in to the system (UTC) DateTime 8  
4.10 / 5.4 - Added OrgRoleId The unique role identifier for the role of the user at the org level. Can be null. Integer 4  
4.10 / 5.4 - Added LastAccessed The date the user last accessed the LE. DateTime 8  
3.1 -Added Version Indicates the version of the content in the row. Timestamp 8  

 

Brightspace Data Set: Course Access

About

Returns information on all the times each user has accessed each course offering across the organization.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

2.4

OrgUnitId

Unique org unit identifier

Integer

4

PK, FK

2.4

UserId

Unique user identifier

Integer

4

PK, FK

2.4

Day Accessed

Indicates the most recent day when a user accessed the course (UTC)

DateTime

8

PK

 

Brightspace Data Set: Enrollments and Withdrawals

About

Returns a list of enrollments and withdrawals for all users in your organization.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

3.2 LogId Unique log entry identifier for any change to the user enrollment Integer 4 PK
3.2

UserId

Unique user identifier

Integer

4

 

3.2

OrgUnitId

Unique org unit identifier

Integer

4

 

3.2

RoleId

Unique role identifier

Integer

4

 

3.2 Action Indicates whether the item is an enrollment or a withdrawal varchar 50  
3.2

EnrollmentType

Enrollment type

String

27

 

3.2 ModifiedByUserId Identifies the last user who modified the enrollment status for the user. Integer 4  
3.2

EnrollmentDate

Date enrolled (UTC)

DateTime

8

 

 

Brightspace Data Set: User Attribute Definitions

About

Returns a list of all defined user attributes in your organization.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

4.10 / 5.4 AttributeId Unique identifier of the attribute. nvarchar 128 PK
4.10 / 5.4

Name

Display name for the attribute.

nvarchar

128

 

4.10 / 5.4

Type

Indicates the type of data stored in the attribute. Can be one of "string", "date", "user" or "org_unit".

nvarchar

8

 

4.10 / 5.4

AllowMultiple

Indicates if multiple values are allowed for the attribute (1) or not (0).

Boolean

1

 

4.10 / 5.4 IsDefault Indicates if the attribute is a default (1) or a custom attribute (0). Boolean 1  
4.10 / 5.4

LastModified

Date the attribute definition was last modified (UTC).

DateTime

8

 

4.10 / 5.4 ModifiedBy User who last modified the attribute definition. Integer 4 FK
4.10 / 5.4

IsDeleted

Indicates if the attribute definition is deleted (1) or not (0).

Boolean

1

 

4.10 / 5.4 Version Indicates the version of the row. This information is used to determine which table row occurred first. BigInteger 8  

 

Brightspace Data Set: User Attribute Values

About

Returns a list of all values for all defined user attributes for each user in your organization.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

4.10 / 5.4 UserId Unique identifier of the user who the attribute is assigned to. Integer 4 PK
4.10 / 5.4 AttributeId Unique identifier of the attribute. nvarchar 128 PK, FK
4.10 / 5.4

Value

Value assigned to the user for the given attribute.

nvarchar

4000

 

4.10 / 5.4

LastModified

Date the attribute value was last modified (UTC).

DateTime

8

 

4.10 / 5.4 ModifiedBy User who last modified the attribute value. Integer 4 FK
4.10 / 5.4

IsDeleted

Indicates if the attribute value is deleted (1) or not (0).

Boolean

1

 

4.10 / 5.4 Version Indicates the version of the row. This information is used to determine which row occurred first. Integer 4