OneRosterOrgOutput

Organization information in the OneRoster format

dateLastModified
Type: stringFormat: date-time
required

Timestamp of when the organization was last modified
identifier
Type: string
required

External identifier for the organization
name
Type: string
required

Title of the organization
sourcedId
Type: string
required

Unique identifier for the organization
status
Type: stringenum
required

Status of an entity in the system
values
- active
- tobedeleted
- inactive
type
Type: stringenum
required

Type of organization
values
- department
- school
- district
- local
- state
- national
children
Type: array object[] · OneRosterGUIDRef[]

References to child organizations
A reference to another OneRoster entity
- href
  Type: stringFormat: uri
  required
  
  URI reference to the entity
- sourcedId
  Type: string
  required
  
  Unique identifier of the referenced entity
- type
  Type: stringenum
  required
  
  Type of the referenced entity
  
  values
  academicSession
  category
  class
  course
  demographics
metadata
Type: object | null

Additional metadata associated with the organization. Can contain custom fields including: privacyPolicyUrl (string), appStoreEnabled (boolean), consentManagementEnabled (boolean), credentialImportMode (string), cameraMicDefault (string: always, at_school, always_off).
- propertyName
  Type: anything
parent
Type: object · OneRosterGUIDRef nullable

Reference to parent organization
- href
  Type: stringFormat: uri
  required
  
  URI reference to the entity
- sourcedId
  Type: string
  required
  
  Unique identifier of the referenced entity
- type
  Type: stringenum
  required
  
  Type of the referenced entity
  
  values
  academicSession
  category
  class
  course
  demographics