OneRosterUserOutput
User information in the OneRoster format
- agentsType:requiredProperties: 3
Array of agents (parents, guardians) associated with the user
- dateType: stringFormat: date-time
Last Modified requiredTimestamp of when the user was last modified
- emailType: stringrequired
User's email address
- enabledType: "true" or "false"enum
User requiredThis is used to determine whether or not the record is active in the local system.
- familyType: string
Name requiredThe family name. Also, known as the last name.
- givenType: string
Name requiredThe given name. Also, known as the first name.
- gradesType: array of stringrequired
Array of grade levels associated with the user
- resourcesType:requiredProperties: 3
The identifiers (GUIDs) for the set of resources that are to be made available to the user.
- rolesType:requiredProperties: 7
Array of roles assigned to the user
- sourcedType: string
Id requiredUnique identifier for the user
- statusType: enumrequired
Status of an entity in the system
valuesactivetobedeletedinactive - userType:
Ids requiredProperties: 2The set of external user identifiers that should be used for this user.
- userType:
Profiles requiredProperties: 7Array of profiles associated with the user in different systems
- identifierType: string | null
Additional identifier for the user
- metadataType: object | nullProperties: 1
Additional metadata associated with the user
- middleType: string | null
Name The set of middle names. If more than one middle name is needed separate using a space.
- passwordType: string | null
User's password (hashed)
- phoneType: string | null
User's primary phone number
- preferredType: string | null
First Name User's preferred first name if different from given name
- preferredType: string | null
Last Name User's preferred last name if different from family name
- preferredType: string | null
Middle Name User's preferred middle name if different from middle name
- primaryType: nullable
Org Properties: 3ID of the user's primary organization
- smsType: string | null
User's SMS contact number
- userType: string | null
Master Identifier The master unique identifier for this user. This is NOT the same as the user's interoperability 'sourcedId'.
- usernameType: string | null
The user name assigned to the user.
