OneRosterOrgOutput

Organization information in the OneRoster format

dateLastModified
Type: string Format: 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: string · EntityStatusenum
required

Status of an entity in the system
values
- active
- tobedeleted
- inactive
type
Type: string enum
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: string Format: uri
  required
  
  URI reference to the entity
- sourcedId
  Type: string
  required
  
  Unique identifier of the referenced entity
- type
  Type: string enum
  required
  
  Type of the referenced entity
  
  values
  academicSession
  category
  class
  course
  demographics
metadata
Type: object | null

Opaque key-value metadata for caller-defined data. Transitional: the 5 legacy config keys below are read-only and derived from the organization's deprecated config columns (not stored in metadata); they are re-exposed here for backward compatibility with consumers that read config from metadata, and will be removed once those consumers cut over to GET /orgs/{id}/config.
- appStoreEnabled
  Type: boolean
  read-only
  
  Derived from the deprecated app_store_enabled column.
- cameraMicDefault
  Type: string enum
  read-only
  
  Derived from the deprecated camera_mic_default column.
  
  values
  always_on
  at_school
  user_choice
  always_off
- consentManagementEnabled
  Type: boolean
  read-only
  
  Derived from the deprecated consent_management_enabled column.
- credentialImportMode
  Type: string enum
  read-only
  
  Derived from the deprecated credential_import_mode column.
  
  values
  enabled
  disabled
  inherit
- privacyPolicyUrl
  Type: string
  read-only
  
  Derived from the deprecated privacy_policy_url column.
- propertyName
  Type: anything
parent
Type: object · OneRosterGUIDRefnullable

Reference to parent organization

A reference to another OneRoster entity
- href
  Type: string Format: uri
  required
  
  URI reference to the entity
- sourcedId
  Type: string
  required
  
  Unique identifier of the referenced entity
- type
  Type: string enum
  required
  
  Type of the referenced entity
  
  values
  academicSession
  category
  class
  course
  demographics