A quick explanation of the different columns expected in the users.csv tab.
| Column Field Header | Required | Format | Description |
|---|---|---|---|
| sourcedId | Yes | GUID | Unique ID for the user. SourcedId is used in other files and must be unique across all users. |
| status | Yes for Delta | Enumeration | See section 4.13.8 (OneRoster, 20a) for the enumeration list. This must NOT be used for Bulk mode. |
| dateLastModified | Yes for Delta | DateTime | The date that this record was last modified. This must NOT be used for Bulk mode. |
| enabledUser | Yes | Enumeration | Permitted values: { "true" or "false" }. "false" denotes that the user is an active record but system access is curtailed according to the local administration rules. |
| orgSourcedIds | Yes | List of GUID References | SourcedIds of the Orgs to which this user belongs. Note that in most cases, it is expected that users will belong to a single school. |
| role | Yes | Enumeration | See section 4.13.5 (OneRoster, 20a) for the enumeration list. |
| username | Yes | String | User name |
| userIds | No | List of Strings | External machine-readable ID (e.g. LDAP id, LTI id) for this user. The ID must be accompanied by a type to indicate the nature of the Identifier. The Type and ID values are enclosed in '{}' with a colon used to separate the values. If more than one userId is needed, use double quotes, and separate with commas (per RFC 4180). Examples: {LDAP:Id}"{LDAP:Id},{LTI:Id},{Fed:Id}" |
| givenName | Yes | String | User's first name |
| familyName | Yes | String | User's surname |
| middleName | No | String | User's middle name(s). If more than one, they are separated by space. |
| identifier | No | String | Identifier for the user with a human readable meaning. |
| No | String | Email address for the user. | |
| sms | No | String | SMS address for the user. |
| phone | No | String | Phone number for the user. |
| agentSourcedIds | No | List of GUID References | SourcedIds of the users to which the user has a relationship. If multiple IDs are required, then use double quotes and separate with commas. Note: In most cases, this will be for indicating parental relationships. |
| grades | No | String | Grade(s) for which a user with the role "student" is enrolled. The permitted vocabulary is from CEDS (Version 5) for the "Entry Grade Level" element: https://ceds.ed.gov/elements.aspx. |
| password | No | String | The password for the user. This may or may not be an encrypted string. If encrypted, the systems processing must be aware of the encryption method. |