OneRosterOrgInput

  • organization
    Type: object
    required
    • identifier
      Type: string
      required

      External identifier for the organization

    • name
      Type: string
      required

      Name of the organization

    • parentId
      Type: string | null Format: uuid
      required

      ID of the parent organization (null for top-level organizations)

    • sourcedId
      Type: string Format: uuid
      required

      Unique identifier for the organization

    • type
      Type: string enum
      required

      Type of organization

      values
      • department
      • school
      • district
      • local
      • state
      • national
    • metadata
      Type: object | null

      Opaque key-value metadata for caller-defined data.

    • status
      Type: string enum

      Status of the organization (defaults to active)

      values
      • active
      • tobedeleted
      • inactive