Brightspace Data Sets for Users

Brightspace Data Sets for Users include:

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

int

4

PK, FK

1.0

UserId

Unique user identifier

int

4

PK, FK

5.7 / 6.0 - Updated column size

RoleName

Role name

nvarchar

60

 

1.0

EnrollmentDate

Date enrolled (UTC)

datetime2

8

 

5.7 / 6.0 - Updated column size

EnrollmentType

Enrollment type.

Field can be null.

varchar

50

 

5.7 and 6.0 - Added FK

RoleId Unique role identifier int 4 FK

 

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.

Field can be null

int

4

 

1.0

UserId

Unique user identifier.

Field can be null.

int

4

FK

6.6 - Updated description

UserName

User name used to attempt log in.

nvarchar

256

 

1.0

IP

IP address

varchar

64

 

2.5 / 3.0 - Removed FK

SessionId

Unique session identifier.

Field can be null.

int

4

 

1.0

StatusType

Login status

varchar

50

 

1.0

AttemptDate

Attempt date (UTC)

datetime2

8

 

1.0

ImpersonatingUserId

User ID of impersonator.

Field can be null.

int

4

FK

1.0

TimeOff

Time elapsed in seconds since the last time a user logged in.

Field can be null.

int

4

 

1.4 LoginAttemptId Unique login attempt identifier bigint 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

int

4

PK

5.7 / 6.0 - Updated column size

UserName

User name

nvarchar

270

 

4.9 / 5.3 - Corrected column size

OrgDefinedId

Org defined ID.

Field can be null.

nvarchar

256

 

6.13 / 7.1 - Updated description

FirstName

User's first name. If a preferred first name is provided, it is used. If not, the legal first name is used.

nvarchar

64

 

5.7 / 6.0 - Updated column size

MiddleName

Middle name.

Field can be null.

nvarchar

64

 

6.13 / 7.1 - Updated description

LastName

User's last name. If a preferred last name is provided, it is used. If not, the legal last name is used.

nvarchar

64

 

1.0

IsActive

Is user active?

Field can be null.

bit

1

 

5.7 / 6.0 - Updated column size

Organization

Organization name.

Field can be null.

varchar

256

 

5.7 / 6.0 - Updated column size

ExternalEmail

External email address.

Field can be null.

nvarchar

256

 

1.0

SignupDate

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

Field can be null.

datetime2

8

 

3.0 - Added FirstLoginDate

Date when the user first logged in to the system (UTC).

Field can be null.

datetime2 8  

3.1 -Added

Version

Indicates the version of the content in the row.

Field can be null.

bigint 8  
4.10 / 5.4 - Added OrgRoleId

The unique role identifier for the role of the user at the org level.

Field can be null.

int 4  
6.13 / 7.1 - Updated description LastAccessed

The date the user last accessed the system. If the user has never accessed the system, captures the date the user was created.

datetime2 8  

 

Brightspace Data Set: Course Access

About

Returns information on all the times each user has accessed each course offering across the organization. The Course Access data set is 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

2.4

OrgUnitId

Unique org unit identifier

int

4

PK, FK

2.4

UserId

Unique user identifier

int

4

PK, FK

2.4

DayAccessed

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

Field can be null.

datetime2

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

5.7 / 6.0 - Updated column size

LogId

Unique log entry identifier for any change to the user enrollment.

Field can be null.

bigint 8 PK

5.7 / 6.0 - Added FK

UserId

Unique user identifier

int

4

FK

5.7 / 6.0 - Added FK

OrgUnitId

Unique org unit identifier

int

4

FK

5.7 / 6.0 - Added FK

RoleId

Unique role identifier.

Field can be null.

int

4

FK

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

5.7 / 6.0 - Updated column size

EnrollmentType

Enrollment type.

Field can be null.

varchar

50

 

3.2 ModifiedByUserId

Identifies the last user who modified the enrollment status for the user.

Field can be null.

int 4  
3.2

EnrollmentDate

Date enrolled (UTC)

datetime2

8

 

 

Brightspace Data Set: User Attribute Definitions

About

Returns a list of all defined user attributes in your organization. If no user attributes are defined for your organization, the data set will not generate.

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 (TRUE - 1) or not (FALSE - 0).

bit

1

 

4.10 / 5.4 IsDefault Indicates if the attribute is a default (TRUE - 1) or a custom attribute (FALSE - 0). bit 1  
4.10 / 5.4

LastModified

Date the attribute definition was last modified (UTC).

datetime2

8

 

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

IsDeleted

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

bit

1

 

4.10 / 5.4 Version Indicates the version of the row. This information is used to determine which table row occurred first. bigint 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. If no user attributes are defined for your organization, the data set will not generate.

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

5.7 / 6.0 - Added FK

UserId Unique identifier of the user who the attribute is assigned to. int 4 PK, FK
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).

datetime2

8

 

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

IsDeleted

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

bit

1

 

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

 

Brightspace Data Set: Auditor Relationships Log

About

The Auditor Relationships Log data set has a record of auditors and the users they audit in the organization. The User Auditors tool and the d2l.Tools.UserManagement.OrgHasAuditors configuration variable must both be enabled to access this data.

Note: The data set may appear blank unless new auditor-learner relationships are added. All historical data is populated 30 to 60 days after the November 2021/20.21.11 release.

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

6.13 / 7.1

AuditorId

UserId (unique identifier) of the auditor.

int

4

PK, FK

6.13 / 7.1

UserToAuditId

UserId (unique identifier) of the user to be audited by the auditor.

int

4

PK, FK

6.13 / 7.1

OrgUnitId

The organization id where the auditor relationship exists.

int

4

PK, FK

6.13 / 7.1

Action

The action performed on the relationship. Either Created or Deleted.

nvarchar

16

 

6.13 / 7.1

ModifiedBy

UserId who modified the auditor relationship.

int

4

FK

6.13 / 7.1

ModifiedDate

Date and time when the auditor relationship was modified (UTC).

datetime2

8

PK