ABOUT US

1EdTech is the leading member-led non-profit edtech partnership accelerating the digital transformation of learning

The 1EdTech community is guided by a set of educational leadership strategies essential to improving learning experiences and outcomes in K-12, higher education, and lifelong learning

1EdTech community-led workstreams help create a secure, scalable, and best-in-class digital learning ecosystem to serve the needs of all learners

1EdTech standards support seamless interoperability, lower TCO, and greater choice.

The TrustEd Apps Directory is the official listing of products and applications reviewed, vetted, or certified by 1EdTech

1EdTech hosts the annual Learning Impact Conference and other engagement opportunities throughout the year to advance the leadership and ideas that shape the future of digital learning

Student Learning Data Model

User and Organization

IMS standards connect User and Organization data to drive student success strategies, inform academic decisions, guide instructional design, and provide a common data format for student learning research.

Your Go-to Partner

From foundational initiatives to K-12 and higher education digital transformation to data analytics, 1EdTech standards are designed to accelerate your unique journey to the future of education.

Interconnected Data Powers Better Teaching and Learning.

Explore how 1EdTech standards connect your digital ecosystem.

User

Users, Teachers and Students are human beings that are teaching or studying in a class respectively. A single User class is used to represent both teachers and students and a role property is used to distinguish a user's natural role.Humans may have relationships with other humans. For example, a student may have parents. The 'agents' attribute allows for relationships between humans to be expressed. Note that these are typically from the point of view of the student - so a student will link to its parents (via the agent attribute). The reverse view MUST also be modeled, so for example, a user of role 'parent' MUST have agents that are of type 'student'. Note: Teachers MUST NOT be set as agents of students i.e. the teaching relationship is covered via enrollments.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
User Master ID userMasterIdentifier The master unique identifier for this user. This is NOT the same as the user's interoperability 'sourcedId'. This should be used to ensure that all of the system identifiers/accounts etc. can be reconciled to the same user. How this identifier is assigned and its format is beyond the scope of this specification.

Found in OneRoster Rostering Service 1.2

N/A
Username username The user name assigned to the user. NOTE - This has been kept for backwards compatibility with OneRoster 1.1 and the new 'userProfiles' characteristic SHOULD be used instead.

Found in OneRoster Rostering Service 1.2

N/A
External User ID List userIds The set of external user identifiers that should be used for this user, if for some reason the sourcedId cannot be used. This might be an active directory id, an LTI id, or some other machine-readable identifier that is used for this person.

Found in OneRoster Rostering Service 1.2

CEDS Identification > Student Identifier
Similar in intent, with wording differences
Enabled User enabledUser This is used to determine whether or not the record is active in the local system. 'false' denotes that the record is active but system access is curtailed according to the local administration rules.

Found in OneRoster Rostering Service 1.2

N/A
First Name givenName The given name. Also, known as the first name.

Found in OneRoster Rostering Service 1.2

CEDS Name > First Name
Identical in intent, with wording differences
Last Name familyName The family name. Also, known as the last name.

Found in OneRoster Rostering Service 1.2

CEDS Name > Last or Surname
Identical in intent, with wording differences
Middle Name middleName The set of middle names. If more than one middle name is needed separate using a space e.g. 'Wingarde Granville'.

Found in OneRoster Rostering Service 1.2

CEDS Name > Middle Name
Identical in intent, with wording differences
Preferred First Name preferredFirstName The user's preferred first name. This attribute was added in version 1.2.

Found in OneRoster Rostering Service 1.2

N/A
Preferred Middle Name preferredMiddleName The user's preferred middle name(s). This attribute was added in version 1.2.

Found in OneRoster Rostering Service 1.2

N/A
Preferred Last Name preferredLastName The user's preferred last name. This attribute was added in version 1.2.

Found in OneRoster Rostering Service 1.2

N/A
Role Org Affiliations roles The set of roles for each of the orgs to which the user is affilliated. This is expressed as a set of role/org tuples.

Found in OneRoster Rostering Service 1.2

N/A
User Profiles userProfiles The set of system/app/tool profiles for the user.

Found in OneRoster Rostering Service 1.2

N/A
Primary Org primaryOrg It is possible for a user to be a member of more than one organization and to have one or more roles in an organization. This attribute identifies the 'sourcedId' of the primary organization.

Found in OneRoster Rostering Service 1.2

N/A
Identifier identifier An identifier for the user. NOTE - This characteristic is kept for backwards compatibility with OneRoster 1.1/1.0. The 'userIds' characteristic SHOULD be used instead.

Found in OneRoster Rostering Service 1.2

N/A
User Email email The email address for the user.

Found in OneRoster Rostering Service 1.2

CEDS Email > Electronic Mail Address Type
Identical in intent, with wording differences
SMS Number sms The SMS number for the user.

Found in OneRoster Rostering Service 1.2

N/A
Phone Number phone The phone number for the user.

Found in OneRoster Rostering Service 1.2

CEDS Telephone > Primary Telephone Number Indicator
Identical in intent, with wording differences
Agent agents The links to other people i.e. User 'sourcedIds'.

Found in OneRoster Rostering Service 1.2

N/A
Grades grades Grade(s) for which a user with role 'student' is enrolled. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IG, 20] for more details on how to define/use such a vocabulary.

Found in OneRoster Rostering Service 1.2

CEDS Enrollment > Entry Grade Level
Identical in intent, with wording differences
Password password A top-level password for the user. Care should be taken when using this field and the password SHOULD be encrypted.

Found in OneRoster Rostering Service 1.2

N/A
Resources resources The identifiers (GUIDs) for the set of resources that are to be made available to the user. These are the sourcedIds that should be used for obtaining the metadata about the resources using the OR 1.2 Resources Service [ORRES-SM, 20].

Found in OneRoster Rostering Service 1.2

N/A
Interoperability ID sourcedId The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.

Found in OneRoster Rostering Service 1.2

N/A
Record Status status All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.

Found in OneRoster Rostering Service 1.2

N/A
Date Last Modified dateLastModified All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.

Found in OneRoster Rostering Service 1.2

N/A
Metadata metadata All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.

Found in OneRoster Rostering Service 1.2

N/A

User Identifier

This is the set of external user identifiers that should be used for this user, if for some reason the sourcedId cannot be used. This might be an active directory id, an LTI id, or some other machine-readable identifier that is used for this person.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
Type type The type of identifier. This is no predefined vocabuary.

Found in OneRoster Rostering Service 1.2

N/A
Identifier identifier The user identifier.

Found in OneRoster Rostering Service 1.2

N/A

User Profile

The container for the information about a User Profile that will provide the user with access to some system, application, tool, etc.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
Profile ID profileId The unique identifier for the profile. This does not need to be a globally unique identifier but it must be unique within the scope of the user.

Found in OneRoster Rostering Service 1.2

N/A
Profile Type profileType The type of profile. This should be a human readable label that has some significance in the context of the related system, app, tool, etc.

Found in OneRoster Rostering Service 1.2

N/A
Vendor ID vendorId The unique identifier for the vendor of the system, tool, app, etc. which requires the use of this profile.

Found in OneRoster Rostering Service 1.2

N/A
Application ID applicationId Identifier for the application associated with the account. The nature, and how this identifier is assigned is not defined by this specification. This may have a value of 'default' to denote this account should be used for default access to all applications related to this vendor.

Found in OneRoster Rostering Service 1.2

N/A
Description description A human readable description of the use of the profile. This should not contain any security information for access to the account.

Found in OneRoster Rostering Service 1.2

N/A
Credentials credentials The set of credentials that are available for access to this profile.

Found in OneRoster Rostering Service 1.2

N/A

User Set

This is the container for a collection of user instances for a message payload. This may be empty if no instances are found that sustain the applied query constraints. The order is not significant.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
Users users The collection of user instances. The order is not significant. The corresponding query constraints may result in no instances being returned.

Found in OneRoster Rostering Service 1.2

N/A

Role Vocabulary

The permitted vocabulary for the 'role' value for the targeted user of a resource.

These properties are found in the OneRoster Resources Service 1.2
Learn more about OneRoster Resources Service

Name Technical Term Description Crosswalks (If Currently Available)
Administrator administrator Administrator in the organization (e.g. School).

Found in OneRoster Resources Service 1.2

N/A
Aide aide Someone who provides appropriate aide to the user but NOT also one of the other roles.

Found in OneRoster Resources Service 1.2

N/A
Guardian guardian Guardian of the user and NOT the Mother or Father. May also be a Relative.

Found in OneRoster Resources Service 1.2

N/A
Parent parent Mother or father of the user.

Found in OneRoster Resources Service 1.2

N/A
Proctor proctor Exam proctor. May be used for enrollment.

Found in OneRoster Resources Service 1.2

N/A
Relative relative A relative of the user and NOT the Mother or Father. May also be the Guardian.

Found in OneRoster Resources Service 1.2

N/A
Student student A student at an organization (e.g. School).

Found in OneRoster Resources Service 1.2

N/A
Teacher teacher A Teacher at an organization (e.g. School).

Found in OneRoster Resources Service 1.2

N/A

Role Vocabulary

The data-type for the 'role' characteristic used to identify the type of user for whom the resources are targetted. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.

These properties are found in the OneRoster Resources Service 1.2
Learn more about OneRoster Resources Service

Name Technical Term Description Crosswalks (If Currently Available)
Administrator administrator Administrator in the organization (e.g. School).

Found in OneRoster Resources Service 1.2

N/A
Aide aide Someone who provides appropriate aide to the user but NOT also one of the other roles.

Found in OneRoster Resources Service 1.2

N/A
Guardian guardian Guardian of the user and NOT the Mother or Father. May also be a Relative.

Found in OneRoster Resources Service 1.2

N/A
Parent parent Mother or father of the user.

Found in OneRoster Resources Service 1.2

N/A
Proctor proctor Exam proctor. May be used for enrollment.

Found in OneRoster Resources Service 1.2

N/A
Relative relative A relative of the user and NOT the Mother or Father. May also be the Guardian.

Found in OneRoster Resources Service 1.2

N/A
Student student A student at an organization (e.g. School).

Found in OneRoster Resources Service 1.2

N/A
Teacher teacher A Teacher at an organization (e.g. School).

Found in OneRoster Resources Service 1.2

N/A
pattern pattern The regular expression to constrain the structure of the string that MUST be used when creating a new, proprietary, vocabulary term. The term must start with the substring 'ext:'.

Found in OneRoster Resources Service 1.2

N/A

Role Vocabulary

The data-type that enables the 'RoleEnum' vocabulary to be extended.

These properties are found in the OneRoster Resources Service 1.2
Learn more about OneRoster Resources Service

Name Technical Term Description Crosswalks (If Currently Available)
pattern pattern The regular expression to constrain the structure of the string that MUST be used when creating a new, proprietary, vocabulary term. The term must start with the substring 'ext:'.

Found in OneRoster Resources Service 1.2

N/A

Role

The container for one mapping between a role and an org for the user.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
Role Type roleType Indicates if this role is the primary or secondary role for that org. There MUST be one, and only one, primary role for each org.

Found in OneRoster Rostering Service 1.2

N/A
Role role The role of the user in the org. The permitted values are from an enumerated list.

Found in OneRoster Rostering Service 1.2

N/A
Organization org The link to the associated org i.e. the 'sourcedId' for the org.

Found in OneRoster Rostering Service 1.2

N/A
User Profile userProfile The identifier for the system/tool/app access account that is relevant to this role in the org. The equivalent UserProfile should exist with a 'profileId' equal to this identifier value.

Found in OneRoster Rostering Service 1.2

N/A
Start Date beginDate The start date on which the role becomes active (inclusive).

Found in OneRoster Rostering Service 1.2

N/A
End Date endDate The end date on which the role becomes inactive (exclusive).

Found in OneRoster Rostering Service 1.2

N/A

Role Vocabulary

The set of permitted values for the type of role.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
Aide aide Someone who provides appropriate aid to the user but NOT also one of the other roles.

Found in OneRoster Rostering Service 1.2

N/A
Counselor counselor Someone who has care/pastoral suopervision responsibility for one or more people.

Found in OneRoster Rostering Service 1.2

N/A
Districtadministrator districtAdministrator The district administrator will have responsibility for systems within the district sites and/or for system that are accessed by the schools in the district.

Found in OneRoster Rostering Service 1.2

N/A
Guardian guardian Guardian of the user and NOT the Mother or Father. May also be a Relative.

Found in OneRoster Rostering Service 1.2

N/A
Parent parent Mother or father of the user.

Found in OneRoster Rostering Service 1.2

N/A
Principal principal The schools' Principal or other very senior academic administrator in the School. The principal will have access to confidential/private data about teachers, etc.

Found in OneRoster Rostering Service 1.2

N/A
Proctor proctor Exam proctor. May be used for enrollment.

Found in OneRoster Rostering Service 1.2

N/A
Relative relative A relative of the user and NOT the Mother or Father. May also be the Guardian.

Found in OneRoster Rostering Service 1.2

N/A
Siteadministrator siteAdministrator Site administrator in the organization e.g. School. The site administrator will have responsibility for all of the systems at the site.

Found in OneRoster Rostering Service 1.2

N/A
Student student A student at a organization e.g. School. May be used for enrollment.

Found in OneRoster Rostering Service 1.2

N/A
Systemadministrator systemAdministrator System administrator in the organization e.g. School. The system administrator will have responsibility for one of more systems at the site.

Found in OneRoster Rostering Service 1.2

N/A
Teacher teacher A Teacher at organization e.g. School. May be used for enrollment.

Found in OneRoster Rostering Service 1.2

N/A

Demographics

Demographics information is taken from the Common Educational Data Standards (CEDS) from the US government. (http://ceds.ed.gov). Note that demographics data is held in its own service, and that access to this service is considered privileged. Not all consumer keys will be able to request demographics data.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
Birth Date birthDate the date of birth. The format is [ISO 8601] of 'YYYY-MM-DD'.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > Birthdate
Identical in intent, with wording differences
Sex sex The sex of the individual. The permitted values are from an enumerated list.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > Sex
Identical in intent, with wording differences
American Indian or Alaska Native americanIndianOrAlaskaNative Identification of whether or not the user is an American Indian or Alaska Native ethnicity.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > American Indian or Alaska Native
Identical in intent, with wording differences
Asian asian Identification of whether or not the user is of Asian ethnicity.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > Asian
Identical in intent, with wording differences
Black or African American blackOrAfricanAmerican Identification of whether or not the user is black or African American ethnicity.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > Black or African American
Identical in wording
Native Hawaiian or Other Pacific Islander nativeHawaiianOrOtherPacificIslander Identification of whether or not the user is Native Hawaiian or Other Pacific Islander ethnicity.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > Native Hawaiian or Other Pacific Islander
Identical in intent, with wording differences
White white Identification of whether or not the user is of white ethnicity.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > White
Identical in intent, with wording differences
Two or More Races demographicRaceTwoOrMoreRaces Identification of whether or not the user has a demographic of two or more race ethnicities.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > Demographic Race Two or More Races
Identical in wording
Hispanic of Latino Ethnicity hispanicOrLatinoEthnicity Identification of whether or not the user is Hispanic or of Latino ethnicity.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > Hispanic or Latino Ethnicity
Identical in intent, with wording differences
Birth Country Code countryOfBirthCode The country of birth code. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IG, 20] for more details on how to define/use such a vocabulary.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > Country of Birth Code
Identical in intent, with wording differences
Birth State Abbreviation stateOfBirthAbbreviation The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a person was born. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IG, 20] for more details on how to define/use such a vocabulary.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > State of Birth Abbreviation
Identical in wording
Birth City cityOfBirth The name of the city in which the user was born.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > City of Birth
Identical in wording
Public School Residence Status publicSchoolResidenceStatus An indication of the location of a person's legal residence relative to (within or outside) the boundaries of the public school attended and its administrative unit. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IG, 20] for more details on how to define/use such a vocabulary.

Found in OneRoster Rostering Service 1.2

CEDS Demographic > Public School Residence Status
Identical in intent, with wording differences
Interoperability ID sourcedId The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.

Found in OneRoster Rostering Service 1.2

N/A
Record Status status All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.

Found in OneRoster Rostering Service 1.2

N/A
Date Last Modified dateLastModified All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.

Found in OneRoster Rostering Service 1.2

N/A
Metadata metadata All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.

Found in OneRoster Rostering Service 1.2

N/A

Demographics Set

This is the container for a collection of demographics instances for a message payload. This may be empty if no instances are found that sustain the applied query constraints. The order is not significant.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
Demographics demographics The collection of demographics instances. The order is not significant. The corresponding query constraints may result in no instances being returned.

Found in OneRoster Rostering Service 1.2

N/A

Org

ORG is defined here as a structure for holding organizational information. An ORG might be a school, or it might be a local, statewide, or national entity. ORGs will typically have a parent ORG (up to the national level), and children, allowing a hierarchy to be established. School is defined here as the place where the learning happens. Most commonly this is the data that describes a bricks and mortar building, or, in the case of a virtual school, the virtual school organization. For enrollment and result reporting purposes, little information about this organization is required. A common example of a local organization is a school district.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
Name name The name of the organization.

Found in OneRoster Rostering Service 1.2

CEDS Identification > Organization Name
Identical in intent, with wording differences
Type type The type of organization. This uses a predefined vocabulary.

Found in OneRoster Rostering Service 1.2

CEDS Identification > Organization Type
Identical in intent, with wording differences
ID identifier Human readable identifier for this org e.g. NCES ID.

Found in OneRoster Rostering Service 1.2

CEDS Identification > Organization Identifier
Identical in intent, with wording differences
Parent ID parent The 'sourcedId' of the parent organization.

Found in OneRoster Rostering Service 1.2

N/A
Children ID children The 'sourcedIds' for the set of child organizations.

Found in OneRoster Rostering Service 1.2

N/A
Interoperability ID sourcedId The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.

Found in OneRoster Rostering Service 1.2

N/A
Record Status status All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.

Found in OneRoster Rostering Service 1.2

N/A
Date Last Modified dateLastModified All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.

Found in OneRoster Rostering Service 1.2

N/A
Metadata metadata All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.

Found in OneRoster Rostering Service 1.2

N/A

Single Org

This is the container for a single org instance for a message payload.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
Org org The instance of the single org for a message payload. There must be a data payload otherwise an error report payload for the record not being located should be returned.

Found in OneRoster Rostering Service 1.2

N/A

Credentials

The container for a single set of credentials for an account.

These properties are found in the OneRoster Rostering Service 1.2
Learn more about OneRoster Rostering Service

Name Technical Term Description Crosswalks (If Currently Available)
Credential Type type The type of credentials for the profile. This should be indicative of when this specific credential should be used.

Found in OneRoster Rostering Service 1.2

CEDS Credential or License > Credential Type
Related only at a concept level, with differences in the intent
User Name username The username.

Found in OneRoster Rostering Service 1.2

N/A
Password password The password in this set of credentials. Care should be taken to ensure that no unencrypted value is revealed.

Found in OneRoster Rostering Service 1.2

N/A
Credential Extensions extensions The set of proprietary extensions to enable other important credential information to be supplied. This information will only be relevant in the context of the corresponding system/app/tool. The form of this information is dependent on the type of binding being used.

Found in OneRoster Rostering Service 1.2

N/A

Single Demographics

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
Demographics demographics

Found in OneRoster REST API Specification 1.1

N/A

User Identifier

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
User ID Type type

Found in OneRoster REST API Specification 1.1

N/A
ID identifier

Found in OneRoster REST API Specification 1.1

N/A

Demographics

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
Birth Date birthDate

Found in OneRoster REST API Specification 1.1

N/A
Sex sex

Found in OneRoster REST API Specification 1.1

N/A
American Indian or Alaska Native americanIndianOrAlaskaNative

Found in OneRoster REST API Specification 1.1

N/A
Asian asian

Found in OneRoster REST API Specification 1.1

N/A
Black or African American blackOrAfricanAmerican

Found in OneRoster REST API Specification 1.1

N/A
Native Hawaiian or Other Pacific Islander nativeHawaiianOrOtherPacificIslander

Found in OneRoster REST API Specification 1.1

N/A
White white

Found in OneRoster REST API Specification 1.1

N/A
Two or More Races demographicRaceTwoOrMoreRaces

Found in OneRoster REST API Specification 1.1

N/A
Hispanic of Latino Ethnicity hispanicOrLatinoEthnicity

Found in OneRoster REST API Specification 1.1

N/A
Birth Country Code countryOfBirthCode

Found in OneRoster REST API Specification 1.1

N/A
Birth State Abbreviation stateOfBirthAbbreviation

Found in OneRoster REST API Specification 1.1

N/A
Birth City cityOfBirth

Found in OneRoster REST API Specification 1.1

N/A
Public School Residence Status publicSchoolResidenceStatus

Found in OneRoster REST API Specification 1.1

N/A
Interoperability ID sourcedId

Found in OneRoster REST API Specification 1.1

N/A
Record Status status

Found in OneRoster REST API Specification 1.1

N/A
Date Last Modified dateLastModified

Found in OneRoster REST API Specification 1.1

N/A
Metadata metadata

Found in OneRoster REST API Specification 1.1

N/A

User Set

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
Users users

Found in OneRoster REST API Specification 1.1

N/A

Demographics Set

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
Demographics demographics

Found in OneRoster REST API Specification 1.1

N/A

Role Vocabulary

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
Administrator administrator

Found in OneRoster REST API Specification 1.1

N/A
Aide aide

Found in OneRoster REST API Specification 1.1

N/A
Guardian guardian

Found in OneRoster REST API Specification 1.1

N/A
Parent parent

Found in OneRoster REST API Specification 1.1

N/A
Proctor proctor

Found in OneRoster REST API Specification 1.1

N/A
Relative relative

Found in OneRoster REST API Specification 1.1

N/A
Student ID student

Found in OneRoster REST API Specification 1.1

N/A
Teacher teacher

Found in OneRoster REST API Specification 1.1

N/A

User Link Data

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
User Name username

Found in OneRoster REST API Specification 1.1

N/A
External User ID List userIds

Found in OneRoster REST API Specification 1.1

N/A
Enabled User enabledUser

Found in OneRoster REST API Specification 1.1

N/A
First Name givenName

Found in OneRoster REST API Specification 1.1

N/A
Last Name familyName

Found in OneRoster REST API Specification 1.1

N/A
Middle Name middleName

Found in OneRoster REST API Specification 1.1

N/A
Role role

Found in OneRoster REST API Specification 1.1

N/A
ID identifier

Found in OneRoster REST API Specification 1.1

N/A
User Email email

Found in OneRoster REST API Specification 1.1

N/A
SMS Number sms

Found in OneRoster REST API Specification 1.1

N/A
Phone Number phone

Found in OneRoster REST API Specification 1.1

N/A
Agent agents

Found in OneRoster REST API Specification 1.1

N/A
Orgs orgs

Found in OneRoster REST API Specification 1.1

N/A
Grade Level grades

Found in OneRoster REST API Specification 1.1

N/A
Password password

Found in OneRoster REST API Specification 1.1

N/A
Interoperability ID sourcedId

Found in OneRoster REST API Specification 1.1

N/A
Record Status status

Found in OneRoster REST API Specification 1.1

N/A
Date Last Modified dateLastModified

Found in OneRoster REST API Specification 1.1

N/A
Metadata metadata

Found in OneRoster REST API Specification 1.1

N/A

Gender Vocabulary

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
Male male

Found in OneRoster REST API Specification 1.1

N/A
Female female

Found in OneRoster REST API Specification 1.1

N/A

Org Set

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
Orgs orgs

Found in OneRoster REST API Specification 1.1

N/A

Single User

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
User user

Found in OneRoster REST API Specification 1.1

N/A

Org Type Vocabulary

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
Department department

Found in OneRoster REST API Specification 1.1

N/A
District district

Found in OneRoster REST API Specification 1.1

N/A
Local local

Found in OneRoster REST API Specification 1.1

N/A
National national

Found in OneRoster REST API Specification 1.1

N/A
School ID school

Found in OneRoster REST API Specification 1.1

N/A
State state

Found in OneRoster REST API Specification 1.1

N/A

Single Org

These properties are found in the OneRoster REST API Specification 1.1
Learn more about OneRoster REST API Specification

Name Technical Term Description Crosswalks (If Currently Available)
Org org

Found in OneRoster REST API Specification 1.1

N/A
Back to the Student Learning Data Model

Help us improve the SLDM by sending feedback to datamodel@imsglobal.org.